| Name | audioscrape JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | |
| Summary | Scrape online audio with a simple command-line interface. |
| upload_time | 2023-08-01 00:36:15 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Carl Thomé Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
audio
music
sound
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Audioscrape
Scrape audio from various websites with a simple command-line interface.
## Usage
First make sure Python is installed, then run:
```sh
pip install audioscrape
```
Then you can use the program as:
```sh
audioscrape "acoustic guitar"
```
See `audioscrape --help` for more details.
### Python API
You can also use the scraper directly in Python, as:
```python
import audioscrape
audioscrape.download(
query="Cerulean Crayons",
include=["guitar"],
exclude=["remix"],
quiet=True,
)
```
## Develop
First clone the repo and set it as working directory. Then install the package in development mode (preferably within its own virtual environment):
```sh
pip install -e .[tests]
```
If you have `direnv` installed, you can run `direnv allow` to automatically create and activate a Python virtual environment when you enter the directory.
### Test
```sh
pytest
```
### Lint
```sh
pre-commit run --all-files
```
Or `pre-commit install` to run automatically on `git commit`.
Raw data
{
"_id": null,
"home_page": "",
"name": "audioscrape",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "audio,music,sound",
"author": "",
"author_email": "Carl Thom\u00e9 <carlthome@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/01/d4/23fbf4de2097cc05b356f9f76669228fc5806b68d33e6b3d6c469c389ee0/audioscrape-0.3.1.tar.gz",
"platform": null,
"description": "# Audioscrape\n\nScrape audio from various websites with a simple command-line interface.\n\n## Usage\n\nFirst make sure Python is installed, then run:\n\n```sh\npip install audioscrape\n```\n\nThen you can use the program as:\n\n```sh\naudioscrape \"acoustic guitar\"\n```\n\nSee `audioscrape --help` for more details.\n\n### Python API\n\nYou can also use the scraper directly in Python, as:\n\n```python\nimport audioscrape\n\naudioscrape.download(\n query=\"Cerulean Crayons\",\n include=[\"guitar\"],\n exclude=[\"remix\"],\n quiet=True,\n)\n```\n\n## Develop\n\nFirst clone the repo and set it as working directory. Then install the package in development mode (preferably within its own virtual environment):\n\n```sh\npip install -e .[tests]\n```\n\nIf you have `direnv` installed, you can run `direnv allow` to automatically create and activate a Python virtual environment when you enter the directory.\n\n### Test\n\n```sh\npytest\n```\n\n### Lint\n\n```sh\npre-commit run --all-files\n```\n\nOr `pre-commit install` to run automatically on `git commit`.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Carl Thom\u00e9 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Scrape online audio with a simple command-line interface.",
"version": "0.3.1",
"project_urls": {
"Bugs": "https://github.com/carlthome/audioscrape/issues",
"Homepage": "https://github.com/carlthome/audio-scraper"
},
"split_keywords": [
"audio",
"music",
"sound"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1782e355f7ce2c9957d9b1d2fd1960be86467b85fa527df252c20482ee10fa4e",
"md5": "2aae5c824048c68deb93d6dab0b2e86e",
"sha256": "31713fde67aa961572b75b74c8a9917c6d9d106f12a0d2a60df9816c083fbc27"
},
"downloads": -1,
"filename": "audioscrape-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2aae5c824048c68deb93d6dab0b2e86e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3241192,
"upload_time": "2023-08-01T00:36:12",
"upload_time_iso_8601": "2023-08-01T00:36:12.703183Z",
"url": "https://files.pythonhosted.org/packages/17/82/e355f7ce2c9957d9b1d2fd1960be86467b85fa527df252c20482ee10fa4e/audioscrape-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01d423fbf4de2097cc05b356f9f76669228fc5806b68d33e6b3d6c469c389ee0",
"md5": "0a9396de1c440e51c9544e5dbea19ebc",
"sha256": "3bdec301880dd0283be9ee32e5da4d3db4a140cd198c1298756c56e260e453ae"
},
"downloads": -1,
"filename": "audioscrape-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "0a9396de1c440e51c9544e5dbea19ebc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3563191,
"upload_time": "2023-08-01T00:36:15",
"upload_time_iso_8601": "2023-08-01T00:36:15.049077Z",
"url": "https://files.pythonhosted.org/packages/01/d4/23fbf4de2097cc05b356f9f76669228fc5806b68d33e6b3d6c469c389ee0/audioscrape-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-01 00:36:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "carlthome",
"github_project": "audioscrape",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "audioscrape"
}
