| Name | AzuracastPy JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | A Python wrapper for the AzuraCast API |
| upload_time | 2024-05-08 22:37:14 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
azuracast
api
wrapper
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
AzuracastPy: The Unofficial Python Wrapper for the Azuracast API
================================================================
AzuracastPy is a Python package that allows for straightforward access
to `AzuraCast <https://www.azuracast.com/>`_'s API.
Installation
------------
AzuracastPy can be installed using `pip <https://pypi.python.org/pypi/pip>`_.
.. code-block:: console
pip install AzuracastPy
Quickstart
----------
With the url of a radio hosted on AzuraCast, an instance of the AzuracastClient
class can be created like so (`An API Key <https://www.azuracast.com/docs/developers/apis/>`_
is needed for more sensitive requests):
.. code-block:: python
from AzuracastPy import AzuracastClient
client = AzuracastClient(
radio_url="radio_url",
api_key="(Optional) api_key"
)
With this instance, radio stations can be interacted with and queried:
.. code-block:: python
# Get all stations served from the hosted radio.
stations = client.stations()
print(stations)
# Get data of a specific station.
station = client.station(1)
print(station.name, station.description, station.requestable_songs())
# Create a podcast on a station (API Key required).
from AzuracastPy.enums import Languages, PodcastCategories
station = client.station(1)
new_podcast = station.podcast.create(
title="New podcast",
description="This is a random description",
language=Languages.ARABIC,
categories=[
PodcastCategories.Arts.DESIGN,
PodcastCategories.Comedy.COMEDY_INTERVIEWS
]
)
Documentation
-------------
AzuracastPy's documentation is located at https://azuracastpy.readthedocs.io/en/latest/.
Raw data
{
"_id": null,
"home_page": null,
"name": "AzuracastPy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "azuracast, api, wrapper",
"author": null,
"author_email": "Abah Olotuche Gabriel <gabrielabah38@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/59/1c/c010497bf370a95f94b1f7958c523e9d2382e31a34a69f431122b398e853/azuracastpy-0.0.2.tar.gz",
"platform": null,
"description": "AzuracastPy: The Unofficial Python Wrapper for the Azuracast API\r\n================================================================\r\n\r\nAzuracastPy is a Python package that allows for straightforward access\r\nto `AzuraCast <https://www.azuracast.com/>`_'s API.\r\n\r\nInstallation\r\n------------\r\n\r\nAzuracastPy can be installed using `pip <https://pypi.python.org/pypi/pip>`_.\r\n\r\n.. code-block:: console\r\n\r\n pip install AzuracastPy\r\n\r\nQuickstart\r\n----------\r\n\r\nWith the url of a radio hosted on AzuraCast, an instance of the AzuracastClient\r\nclass can be created like so (`An API Key <https://www.azuracast.com/docs/developers/apis/>`_\r\nis needed for more sensitive requests):\r\n\r\n.. code-block:: python\r\n\r\n from AzuracastPy import AzuracastClient\r\n\r\n client = AzuracastClient(\r\n radio_url=\"radio_url\",\r\n api_key=\"(Optional) api_key\"\r\n )\r\n\r\nWith this instance, radio stations can be interacted with and queried:\r\n\r\n.. code-block:: python\r\n\r\n # Get all stations served from the hosted radio.\r\n stations = client.stations()\r\n print(stations)\r\n\r\n # Get data of a specific station.\r\n station = client.station(1)\r\n print(station.name, station.description, station.requestable_songs())\r\n\r\n # Create a podcast on a station (API Key required).\r\n from AzuracastPy.enums import Languages, PodcastCategories\r\n\r\n station = client.station(1)\r\n\r\n new_podcast = station.podcast.create(\r\n title=\"New podcast\",\r\n description=\"This is a random description\",\r\n language=Languages.ARABIC,\r\n categories=[\r\n PodcastCategories.Arts.DESIGN,\r\n PodcastCategories.Comedy.COMEDY_INTERVIEWS\r\n ]\r\n )\r\n\r\nDocumentation\r\n-------------\r\n\r\nAzuracastPy's documentation is located at https://azuracastpy.readthedocs.io/en/latest/.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python wrapper for the AzuraCast API",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/ARandomBoiIsMe/AzuracastPy",
"Issues": "https://github.com/ARandomBoiIsMe/AzuracastPy/issues"
},
"split_keywords": [
"azuracast",
" api",
" wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "373728dd96e326eefa06398ff66dc1eba078e87c992950110b0a858780f450a3",
"md5": "45a10b9700305014be667d7ba44aaad3",
"sha256": "3b32bb8283876a67ff7685f230835e3b6c9439061afa76ee97ffd8ce1e2151d9"
},
"downloads": -1,
"filename": "AzuracastPy-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "45a10b9700305014be667d7ba44aaad3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 96791,
"upload_time": "2024-05-08T22:37:11",
"upload_time_iso_8601": "2024-05-08T22:37:11.502316Z",
"url": "https://files.pythonhosted.org/packages/37/37/28dd96e326eefa06398ff66dc1eba078e87c992950110b0a858780f450a3/AzuracastPy-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "591cc010497bf370a95f94b1f7958c523e9d2382e31a34a69f431122b398e853",
"md5": "766128c0078f1f0c55a21e3b77c2f30d",
"sha256": "8d5104a85ed29ea4abb402eef4197ede3a2ce7544be385c147783785e1298765"
},
"downloads": -1,
"filename": "azuracastpy-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "766128c0078f1f0c55a21e3b77c2f30d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 84760,
"upload_time": "2024-05-08T22:37:14",
"upload_time_iso_8601": "2024-05-08T22:37:14.376951Z",
"url": "https://files.pythonhosted.org/packages/59/1c/c010497bf370a95f94b1f7958c523e9d2382e31a34a69f431122b398e853/azuracastpy-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 22:37:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ARandomBoiIsMe",
"github_project": "AzuracastPy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "azuracastpy"
}
