No description
  • Python 94.6%
  • Shell 4.4%
  • Dockerfile 1%
Find a file
Christopher Bailey dd25b56d7a
Some checks failed
CI / Test and Lint (push) Has been cancelled
CI / Test and Lint-1 (push) Has been cancelled
CI / Test and Lint-2 (push) Has been cancelled
CI / Test and Lint-3 (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
Fixes update-requirements
2021-07-24 11:56:47 -04:00
.bin Fixes update-requirements 2021-07-24 11:56:47 -04:00
.devcontainer Adds automatic failover to secondary HLS 2021-07-16 15:19:41 -04:00
.github Re-add release.yml 2021-07-15 11:20:28 -04:00
.vscode Adds back pytest 2021-07-14 23:25:33 -04:00
docs Furo sphinx theme 2021-07-15 00:59:15 -04:00
sxm Version bump 2021-07-24 11:51:44 -04:00
tests Adds automatic failover to secondary HLS 2021-07-16 15:19:41 -04:00
.bandit.yml Adds back pytest 2021-07-14 23:25:33 -04:00
.codeclimate.yml Tweaks codeclimate 2021-07-15 00:17:36 -04:00
.editorconfig Initial package conversation commit 2018-12-25 13:56:16 -05:00
.gitignore Adds github actions workflow 2021-07-14 20:03:55 -04:00
AUTHORS.rst Clean up 2019-05-18 17:39:27 -04:00
conftest.py Linting 2021-07-15 21:41:16 -04:00
CONTRIBUTING.rst Clean up 2019-05-18 17:39:27 -04:00
dev-requirements.txt Updates requirements 2021-07-23 12:37:16 -04:00
HISTORY.rst Version bump 2021-07-24 11:51:44 -04:00
LICENSE Clean up 2019-05-18 17:39:27 -04:00
mypy.ini Combines CI and Release workflows 2021-07-15 11:09:00 -04:00
pyproject.toml Make bin command smarter 2021-07-17 12:01:12 -04:00
README.rst README adjust 2021-07-17 21:55:04 -04:00
readthedocs.yml Fixes readthedocs.yml 2021-07-15 09:09:21 -04:00
requirements.txt Updates requirements 2021-07-23 12:37:16 -04:00

sxm-client
==========

.. image:: https://readthedocs.org/projects/sxm-client/badge/?version=latest
    :target: https://sxm-client.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://github.com/AngellusMortis/sxm-client/actions/workflows/ci.yml/badge.svg
    :target: https://github.com/AngellusMortis/sxm-client/actions/workflows/ci.yml
    :alt: CI Status

.. image:: https://api.codeclimate.com/v1/badges/ea06824c1732b39d7d0b/maintainability
    :target: https://codeclimate.com/github/AngellusMortis/sxm-client/maintainability
    :alt: Maintainability

.. image:: https://api.codeclimate.com/v1/badges/ea06824c1732b39d7d0b/test_coverage
    :target: https://codeclimate.com/github/AngellusMortis/sxm-client/test_coverage
    :alt: Test Coverage

.. image:: https://pypip.in/v/sxm/badge.png
    :target: https://pypi.org/project/sxm/
    :alt: Latest PyPI version


.. warning:: Designed for PERSONAL USE ONLY

    ``sxm`` is a 100% unofficial project and you use it at your own risk.
    It is designed to be used for personal use with a small number of users
    listening to it at once. Similar to playing music over a speak from the
    radio directly. Using ``sxm-player`` in any corporate setting, to
    attempt to pirate music, or to try to make a profit off your subscription
    may result in you getting in legal trouble.

``sxm-client`` is a Python library designed to help write applications for the
popular XM Radio service.

* Free software: MIT license
* Documentation: http://sxm-client.readthedocs.io/.

Features
--------

* A simple HTTP Proxy server that can serve HLS streams for sxm-client channels
* Python sxm Client
* Python classes for interface with sxm channel data

For details on usage and installation, see the `documentation`_.

``sxm-client`` is designed to be a bare bones library to setup an anonymous HLS
stream. For a more in-depth applications, check out
`sxm-player`_.

.. _documentation: http://sxm-client.readthedocs.io/
.. _sxm-player: https://github.com/AngellusMortis/sxm-player


Credits
-------

Huge props to andrew0 <andrew0@github.com> for for reverse engineering the
original SXM APIs used

This package was created with Cookiecutter_ and the
`audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage