| Name | nekosama JSON |
| Version |
4.1
JSON |
| download |
| home_page | None |
| Summary | API Wrapper for neko-sama.fr |
| upload_time | 2024-08-25 18:14:14 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT License Copyright (c) 2024 Egsagon 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 |
nekosama
anime
downloader
french
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Nekosama
This is a python package for using with the [NekoSama](https://neko-sama.fr/) anime website.
```shell
pip install nekosama
```
## CLI Usage
This package can be used as a CLI tool.
```shell
$ python -m nekosama -h
usage: nekosama [-h] -i INPUT [-e EPISODES] [-o OUTPUT] [-q {1080p,720p,480p}]
options:
--input INPUT An anime URL
--episodes EPISODES List or range or episodes indexes (e.g. 0-5 or 1,2,3)
--output OUTPUT Output directory
--quality {1080p,720p,480p} Video quality
```
Examples:
```shell
$ nekosama -i <url> # Download a whole anime
$ nekosama -i <url> -q 480p # Download in worst quality
$ nekosama -i <url> -e 1 # Download the first episode of an anime
$ nekosama -i <url> -e 1-8 # Download episodes 1 to 8 (included)
$ nekosama -i <url> -e 1,4,9 # Download specific episodes
```
## Package quickstart
```python
import nekosama
# Initialise a core
core = nekosama.Core()
# Search for animes
for anime in core.database.search(query = 'slime'):
print(anime.title)
# Get an anime from a URL
anime = core.get('https://neko-sama.fr/anime/info/9520-tensei-shitara-slime-datta-ken_vostfr')
# List episodes
for episode in anime.episodes:
print(episode.index, ':', episode.url)
# Download an episode
anime.episodes[0].download(
path = 'ep1.mp4',
quality = 1080
)
```
For more documentation, have a look at the source code and the docstrings.
## License
This project uses the `MIT` license. See the `LICENSE` file for more informations.
Raw data
{
"_id": null,
"home_page": null,
"name": "nekosama",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "nekosama, anime, downloader, french",
"author": null,
"author_email": "Egsagon <egsagon12@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/69/9f/af5fe3302a2c272de4d47edf215016508f0e5f7ca371bad968fef703a245/nekosama-4.1.tar.gz",
"platform": null,
"description": "# Nekosama\n\nThis is a python package for using with the [NekoSama](https://neko-sama.fr/) anime website.\n```shell\npip install nekosama\n```\n\n## CLI Usage\n\nThis package can be used as a CLI tool.\n\n```shell\n$ python -m nekosama -h\nusage: nekosama [-h] -i INPUT [-e EPISODES] [-o OUTPUT] [-q {1080p,720p,480p}]\n\noptions:\n --input INPUT An anime URL\n --episodes EPISODES List or range or episodes indexes (e.g. 0-5 or 1,2,3)\n --output OUTPUT Output directory\n --quality {1080p,720p,480p} Video quality\n```\n\nExamples:\n```shell\n$ nekosama -i <url> # Download a whole anime\n$ nekosama -i <url> -q 480p # Download in worst quality\n$ nekosama -i <url> -e 1 # Download the first episode of an anime\n$ nekosama -i <url> -e 1-8 # Download episodes 1 to 8 (included)\n$ nekosama -i <url> -e 1,4,9 # Download specific episodes\n```\n\n## Package quickstart\n\n```python\nimport nekosama\n\n# Initialise a core\ncore = nekosama.Core()\n\n# Search for animes\nfor anime in core.database.search(query = 'slime'):\n print(anime.title)\n\n# Get an anime from a URL\nanime = core.get('https://neko-sama.fr/anime/info/9520-tensei-shitara-slime-datta-ken_vostfr')\n\n# List episodes\nfor episode in anime.episodes:\n print(episode.index, ':', episode.url)\n\n# Download an episode\nanime.episodes[0].download(\n path = 'ep1.mp4',\n quality = 1080\n)\n```\n\nFor more documentation, have a look at the source code and the docstrings.\n\n## License\n\nThis project uses the `MIT` license. See the `LICENSE` file for more informations.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Egsagon 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": "API Wrapper for neko-sama.fr",
"version": "4.1",
"project_urls": {
"Repository": "https://github.com/Egsagon/nekosama"
},
"split_keywords": [
"nekosama",
" anime",
" downloader",
" french"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "079afc5a98df0d54fac28e018635ca87d1547de3a368ac2545f9d10f0849bd44",
"md5": "fb28b84bbe7383d51c3d829a0d8e0bd4",
"sha256": "2ecbac84a46964052a1d104a2fdf41b080f2d07d7fbb4ab46451a356ba91544e"
},
"downloads": -1,
"filename": "nekosama-4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb28b84bbe7383d51c3d829a0d8e0bd4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9971,
"upload_time": "2024-08-25T18:14:13",
"upload_time_iso_8601": "2024-08-25T18:14:13.096130Z",
"url": "https://files.pythonhosted.org/packages/07/9a/fc5a98df0d54fac28e018635ca87d1547de3a368ac2545f9d10f0849bd44/nekosama-4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "699faf5fe3302a2c272de4d47edf215016508f0e5f7ca371bad968fef703a245",
"md5": "eb3e07f92d97898cb98f006379eaf138",
"sha256": "f1c6f29be2974066719bc37d7b5bde4ef7fc6b0fde0a7dfe5de81c77516a525f"
},
"downloads": -1,
"filename": "nekosama-4.1.tar.gz",
"has_sig": false,
"md5_digest": "eb3e07f92d97898cb98f006379eaf138",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 8769,
"upload_time": "2024-08-25T18:14:14",
"upload_time_iso_8601": "2024-08-25T18:14:14.410089Z",
"url": "https://files.pythonhosted.org/packages/69/9f/af5fe3302a2c272de4d47edf215016508f0e5f7ca371bad968fef703a245/nekosama-4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 18:14:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Egsagon",
"github_project": "nekosama",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nekosama"
}
