=================
ABC Radio Wrapper
=================
.. image:: https://img.shields.io/pypi/v/abc_radio_wrapper.svg
:target: https://pypi.python.org/pypi/abc_radio_wrapper
.. image:: https://img.shields.io/travis/matthewburke1995/abc_radio_wrapper.svg
:target: https://travis-ci.com/matthewburke1995/abc_radio_wrapper
.. image:: https://readthedocs.org/projects/abc-radio-wrapper/badge/?version=latest
:target: https://abc-radio-wrapper.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/MatthewBurke1995/ABC-Radio-Wrapper/main/docs/coverage.svg
API wrapper library for the song history of abc radio channels
* Free software: MIT license
* Documentation: https://abc-radio-wrapper.readthedocs.io.
Quick Start
-----------
.. code-block:: python
import abc_radio_wrapper
ABC = abc_radio_wrapper.ABCRadio()
search_result = ABC.search(station="triplej")
for radio_play in search_result.radio_songs:
print(radio_play.song.title)
for artist in radio_play.song.artists:
print(artist.name)
Features
--------
- Use python to search through the radio catalogue of triplej, ABC jazz, doublej and more!
- full type coverage for fast type hints on modern IDE's
- >90% test coverage
TODO
----
- Pull out dataclasses into seperate class files
- Pull out unittests into seperate files
- Add async queries
Credits
-------
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
=======
History
=======
0.1.0 (2023-01-18)
------------------
* First added to github
* First added to pypi
0.1.1 (2023-01-21)
------------------
* Passing build on readthedocs
0.1.2 (TBA)
* Add usage documentation
* Add docstrings on all functions (pass pydocstyle audit)
0.2.0 (TBA)
-----------
* Include iteration through search results
* Include async requests
0.3.0 (TBA)
-----------
* Add github actions for automatic testing
1.0.0 (TBA)
-----------
Raw data
{
"_id": null,
"home_page": "https://github.com/MatthewBurke1995/ABC-Radio-Wrapper",
"name": "abc-radio-wrapper",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "abc_radio_wrapper",
"author": "Matthew Burke",
"author_email": "mperoburke@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7a/06/e645451d889f86497076a6362aa97a52e2b04c46b2b5b5285f84a10ffacf/abc_radio_wrapper-0.3.0.tar.gz",
"platform": null,
"description": "=================\nABC Radio Wrapper\n=================\n\n\n.. image:: https://img.shields.io/pypi/v/abc_radio_wrapper.svg\n :target: https://pypi.python.org/pypi/abc_radio_wrapper\n\n.. image:: https://img.shields.io/travis/matthewburke1995/abc_radio_wrapper.svg\n :target: https://travis-ci.com/matthewburke1995/abc_radio_wrapper\n\n.. image:: https://readthedocs.org/projects/abc-radio-wrapper/badge/?version=latest\n :target: https://abc-radio-wrapper.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/MatthewBurke1995/ABC-Radio-Wrapper/main/docs/coverage.svg\n\n\n\nAPI wrapper library for the song history of abc radio channels\n\n\n* Free software: MIT license\n* Documentation: https://abc-radio-wrapper.readthedocs.io.\n\n\nQuick Start\n-----------\n\n.. code-block:: python\n\n import abc_radio_wrapper\n\n ABC = abc_radio_wrapper.ABCRadio()\n\n search_result = ABC.search(station=\"triplej\")\n\n for radio_play in search_result.radio_songs:\n print(radio_play.song.title)\n for artist in radio_play.song.artists:\n print(artist.name)\n\n\nFeatures\n--------\n\n- Use python to search through the radio catalogue of triplej, ABC jazz, doublej and more!\n- full type coverage for fast type hints on modern IDE's\n- >90% test coverage\n\n\nTODO\n----\n\n- Pull out dataclasses into seperate class files\n- Pull out unittests into seperate files\n- Add async queries \n\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n0.1.0 (2023-01-18)\n------------------\n\n* First added to github\n* First added to pypi\n\n\n0.1.1 (2023-01-21)\n------------------\n\n* Passing build on readthedocs\n\n0.1.2 (TBA)\n\n* Add usage documentation\n* Add docstrings on all functions (pass pydocstyle audit)\n\n\n0.2.0 (TBA)\n-----------\n\n* Include iteration through search results\n* Include async requests\n\n\n0.3.0 (TBA)\n-----------\n\n* Add github actions for automatic testing\n\n\n1.0.0 (TBA)\n-----------\n\n\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "API wrapper library for the song history of ABC radio channels",
"version": "0.3.0",
"split_keywords": [
"abc_radio_wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d57a10fa148fd14b8bccc27884e50b51316884ba76da281cc5393fcf9c88505a",
"md5": "716dae0017d1b4bf79119f65ffe90ee6",
"sha256": "15b4966ecb991593477e06fad2e00bde250e07881f36a38b9a5b4d874d43dc7d"
},
"downloads": -1,
"filename": "abc_radio_wrapper-0.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "716dae0017d1b4bf79119f65ffe90ee6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 7602,
"upload_time": "2023-01-30T03:00:35",
"upload_time_iso_8601": "2023-01-30T03:00:35.252349Z",
"url": "https://files.pythonhosted.org/packages/d5/7a/10fa148fd14b8bccc27884e50b51316884ba76da281cc5393fcf9c88505a/abc_radio_wrapper-0.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7a06e645451d889f86497076a6362aa97a52e2b04c46b2b5b5285f84a10ffacf",
"md5": "ddd9b9716a3a635165ba9738839b7439",
"sha256": "41eba4ec43acf2e68976107b94485ffcd87a91b90f59131f0522c35584c82085"
},
"downloads": -1,
"filename": "abc_radio_wrapper-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "ddd9b9716a3a635165ba9738839b7439",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 23998,
"upload_time": "2023-01-30T03:00:37",
"upload_time_iso_8601": "2023-01-30T03:00:37.113301Z",
"url": "https://files.pythonhosted.org/packages/7a/06/e645451d889f86497076a6362aa97a52e2b04c46b2b5b5285f84a10ffacf/abc_radio_wrapper-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-30 03:00:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "MatthewBurke1995",
"github_project": "ABC-Radio-Wrapper",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "abc-radio-wrapper"
}
JSON
