# soundcloud.py
[![Tests](https://github.com/7x11x13/soundcloud.py/actions/workflows/ci.yml/badge.svg)](https://github.com/7x11x13/soundcloud.py/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/7x11x13/soundcloud.py/badge.svg?branch=main)](https://coveralls.io/github/7x11x13/soundcloud.py?branch=main)
[![Supported Python Versions](https://img.shields.io/badge/python-3.7%2C%203.8%2C%203.9%2C%203.10%2C%203.11%2C%203.12-blue.svg)](https://pypi.org/project/soundcloud-v2/)
[![Version](https://img.shields.io/pypi/v/soundcloud-v2.svg)](https://pypi.org/project/soundcloud-v2/)
[![License](https://img.shields.io/pypi/l/soundcloud-v2.svg)](https://pypi.org/project/soundcloud-v2/)
[![Monthly Downloads](https://pepy.tech/badge/soundcloud-v2/month)](https://pepy.tech/project/soundcloud-v2)
Python wrapper for some of the internal v2 SoundCloud API (read/GET only methods). Does not require an API key.
### NOTE: This is NOT the official [SoundCloud developer API](https://developers.soundcloud.com/docs/api/guide)
SoundCloud is not accepting any more application registration requests [^1] so
I made this library so developers can use SoundCloud's internal API for their projects.
[^1]: https://docs.google.com/forms/d/e/1FAIpQLSfNxc82RJuzC0DnISat7n4H-G7IsPQIdaMpe202iiHZEoso9w/closedform
## Documentation
https://7x11x13.xyz/soundcloud.py
## Installation
```bash
pip install soundcloud-v2
```
## Example
```python
from soundcloud import SoundCloud
sc = SoundCloud(auth_token="auth_token")
assert sc.is_client_id_valid()
assert sc.is_auth_token_valid()
me = sc.get_user_by_username("7x11x13")
assert me.permalink == "7x11x13"
```
## Notes on `auth_token`
Some methods require authentication in the form of an OAuth2 access token.
You can find your token in your browser cookies for SoundCloud under the name "oauth_token".
A new token will be generated each time you log out and log back in.
## Notes on `**kwargs`
All API methods have a `**kwargs` argument which you can use to pass extra, undocumented
arguments to the SoundCloud v2 API in case I missed some parameter which you find useful.
If this is the case, feel free to create an issue or pull request to document the missing
argument.
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/7x11x13/soundcloud.py",
"name": "soundcloud-v2",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "7x11x13",
"author_email": "x7x11x13@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3b/bb/ba779b3cb9597ddf88bb7b31bd6d2a984f972ee3a8f198d32935540058a7/soundcloud-v2-1.6.0.tar.gz",
"platform": null,
"description": "# soundcloud.py\n\n[![Tests](https://github.com/7x11x13/soundcloud.py/actions/workflows/ci.yml/badge.svg)](https://github.com/7x11x13/soundcloud.py/actions/workflows/ci.yml)\n[![Coverage Status](https://coveralls.io/repos/github/7x11x13/soundcloud.py/badge.svg?branch=main)](https://coveralls.io/github/7x11x13/soundcloud.py?branch=main)\n[![Supported Python Versions](https://img.shields.io/badge/python-3.7%2C%203.8%2C%203.9%2C%203.10%2C%203.11%2C%203.12-blue.svg)](https://pypi.org/project/soundcloud-v2/)\n[![Version](https://img.shields.io/pypi/v/soundcloud-v2.svg)](https://pypi.org/project/soundcloud-v2/)\n[![License](https://img.shields.io/pypi/l/soundcloud-v2.svg)](https://pypi.org/project/soundcloud-v2/)\n[![Monthly Downloads](https://pepy.tech/badge/soundcloud-v2/month)](https://pepy.tech/project/soundcloud-v2)\n\nPython wrapper for some of the internal v2 SoundCloud API (read/GET only methods). Does not require an API key.\n\n### NOTE: This is NOT the official [SoundCloud developer API](https://developers.soundcloud.com/docs/api/guide)\n\nSoundCloud is not accepting any more application registration requests [^1] so\nI made this library so developers can use SoundCloud's internal API for their projects.\n\n\n[^1]: https://docs.google.com/forms/d/e/1FAIpQLSfNxc82RJuzC0DnISat7n4H-G7IsPQIdaMpe202iiHZEoso9w/closedform\n\n## Documentation\n\nhttps://7x11x13.xyz/soundcloud.py\n\n## Installation\n\n```bash\npip install soundcloud-v2\n```\n\n## Example\n\n```python\nfrom soundcloud import SoundCloud\n\nsc = SoundCloud(auth_token=\"auth_token\")\nassert sc.is_client_id_valid()\nassert sc.is_auth_token_valid()\nme = sc.get_user_by_username(\"7x11x13\")\nassert me.permalink == \"7x11x13\"\n```\n\n## Notes on `auth_token`\nSome methods require authentication in the form of an OAuth2 access token.\nYou can find your token in your browser cookies for SoundCloud under the name \"oauth_token\".\nA new token will be generated each time you log out and log back in.\n\n## Notes on `**kwargs`\nAll API methods have a `**kwargs` argument which you can use to pass extra, undocumented\narguments to the SoundCloud v2 API in case I missed some parameter which you find useful.\nIf this is the case, feel free to create an issue or pull request to document the missing\nargument.\n\n## License\n[MIT](https://choosealicense.com/licenses/mit/)\n",
"bugtrack_url": null,
"license": null,
"summary": "Python wrapper for the internal v2 SoundCloud API.Does not require an API key.",
"version": "1.6.0",
"project_urls": {
"Bug Tracker": "https://github.com/7x11x13/soundcloud.py/issues",
"Homepage": "https://github.com/7x11x13/soundcloud.py"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b3b0945ba33081a8c165d7400d22c61968cf4d2472cdc121062842b38952ef9",
"md5": "3fe081f9e89fc7c9f9d0dcae43f36d87",
"sha256": "5e3a6cfcec80f59a5ca6fa631d9bde75140b5472892249197178e5229b402cdb"
},
"downloads": -1,
"filename": "soundcloud_v2-1.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3fe081f9e89fc7c9f9d0dcae43f36d87",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 20684,
"upload_time": "2024-08-01T18:23:31",
"upload_time_iso_8601": "2024-08-01T18:23:31.758532Z",
"url": "https://files.pythonhosted.org/packages/0b/3b/0945ba33081a8c165d7400d22c61968cf4d2472cdc121062842b38952ef9/soundcloud_v2-1.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3bbbba779b3cb9597ddf88bb7b31bd6d2a984f972ee3a8f198d32935540058a7",
"md5": "fb0c968951fc02c7a1602f50ce19ddfe",
"sha256": "462513146c0ffc9ec729c1c616f4f72b0dcd33f81478c64207f265f072e78243"
},
"downloads": -1,
"filename": "soundcloud-v2-1.6.0.tar.gz",
"has_sig": false,
"md5_digest": "fb0c968951fc02c7a1602f50ce19ddfe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 16361,
"upload_time": "2024-08-01T18:23:32",
"upload_time_iso_8601": "2024-08-01T18:23:32.873904Z",
"url": "https://files.pythonhosted.org/packages/3b/bb/ba779b3cb9597ddf88bb7b31bd6d2a984f972ee3a8f198d32935540058a7/soundcloud-v2-1.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-01 18:23:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "7x11x13",
"github_project": "soundcloud.py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "soundcloud-v2"
}