<div align="center">
# One Pyece
<img src="https://raw.githubusercontent.com/icepick4/onepyece/main/docs/onepyece_logo.png" width="200px"/>
*Image generated with Midjourney.*
[](https://forthebadge.com)
[](https://forthebadge.com)
</div>
## Description
Python **API wrapper** for https://api-onepiece.com/ \
Thank's to this package you can simply get informations about One Piece characters, fruits, crews, etc. The datas provided by the API are in french only for the moment. \
Learn more about possibilities in the [Usage](#usage) section.
⚠️*This package is still in development and it's my very first python package, so it may not be stable.*
## Installation
**There are several solutions :**
- Use this command ``pip install onepyece`` to get it from [PyPi](https://pypi.org/project/onepyece/)
- Use this command ``pip install git+https://github.com/icepick4/onepyece`` to download it from this repo.
- Download either the .zip or the tar.gz archive from the last release and then use this command `` pip install <path_to_archive> ``
## Usage
```py
>>> import onepyece as op
>>> sanji = op.character_by_name('sanji') # You can get a character by its name
>>> sanji.birthday
'2000-03-02'
>>> nb_fruits = op.count_fruits() # You can get the count of a specific endpoint
>>> nb_fruits.count
197
>>> nb_fruits.url
https://api.api-onepiece.com/fruits/count
>>> crews = op.API('crews') # List of all the crews in dict form as you can see below
>>> crews[0]
API(object={'endpoint': None, 'search_term': None, 'resource': None, 'object': True, 'id': 1, 'french_name': 'L’équipage du Chapeau de Paille', 'roman_name': 'Mugiwara no Ichimi', 'description': '', 'total_prime': '3.161.000.100', 'number': '10', 'status': 'actif', 'isYonko': True, 'affiliation': ''})
>>> crews.count # You can implicitly get the count of an endpoint by getting the whole list of it.
149
>>>crews[1].french_name
'L’équipage du Roux'
```
To learn more about the possibilities, you can check the
detailed **documentation** [here](docs/) and more examples [here](docs/examples.py).
## Tests
You can test the application by running ``python -m tests``
## Contributing
Pull requests are welcome. Do not hesitate to open an issue if you have any problem or suggestion.
## License
This project is under the MIT License.
## Author
<a href="https://github.com/icepick4"><img src="https://avatars.githubusercontent.com/u/82316285?v=4" width="100px;" alt="Remi Jara"/><br /><sub><b>Remi Jara</b></sub></a>
Raw data
{
"_id": null,
"home_page": "https://github.com/icepick4/onepyece",
"name": "onepyece",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "one-piece api wrapper onepyece onepiece onepiece-api onepiece-api-wrapper manga anime anime-manga",
"author": "R\u00e9mi JARA",
"author_email": "remi.jara4@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a1/d5/859491e57ef60e8cf2a9867469cbb063255eac9d21b35b959635ec70e484/onepyece-2.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\r\n\r\n# One Pyece\r\n\r\n<img src=\"https://raw.githubusercontent.com/icepick4/onepyece/main/docs/onepyece_logo.png\" width=\"200px\"/>\r\n\r\n*Image generated with Midjourney.*\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n[](https://forthebadge.com)\r\n[](https://forthebadge.com)\r\n\r\n</div>\r\n\r\n## Description\r\n\r\nPython **API wrapper** for https://api-onepiece.com/ \\\r\nThank's to this package you can simply get informations about One Piece characters, fruits, crews, etc. The datas provided by the API are in french only for the moment. \\\r\nLearn more about possibilities in the [Usage](#usage) section. \r\n\r\n\u26a0\ufe0f*This package is still in development and it's my very first python package, so it may not be stable.*\r\n\r\n## Installation\r\n\r\n**There are several solutions :**\r\n\r\n- Use this command ``pip install onepyece`` to get it from [PyPi](https://pypi.org/project/onepyece/)\r\n- Use this command ``pip install git+https://github.com/icepick4/onepyece`` to download it from this repo.\r\n- Download either the .zip or the tar.gz archive from the last release and then use this command `` pip install <path_to_archive> ``\r\n\r\n## Usage\r\n\r\n```py\r\n>>> import onepyece as op\r\n>>> sanji = op.character_by_name('sanji') # You can get a character by its name\r\n>>> sanji.birthday\r\n'2000-03-02'\r\n>>> nb_fruits = op.count_fruits() # You can get the count of a specific endpoint\r\n>>> nb_fruits.count\r\n197\r\n>>> nb_fruits.url\r\nhttps://api.api-onepiece.com/fruits/count\r\n>>> crews = op.API('crews') # List of all the crews in dict form as you can see below\r\n>>> crews[0]\r\nAPI(object={'endpoint': None, 'search_term': None, 'resource': None, 'object': True, 'id': 1, 'french_name': 'L\u2019\u00e9quipage du Chapeau de Paille', 'roman_name': 'Mugiwara no Ichimi', 'description': '', 'total_prime': '3.161.000.100', 'number': '10', 'status': 'actif', 'isYonko': True, 'affiliation': ''})\r\n>>> crews.count # You can implicitly get the count of an endpoint by getting the whole list of it.\r\n149\r\n>>>crews[1].french_name\r\n'L\u2019\u00e9quipage du Roux'\r\n```\r\n\r\nTo learn more about the possibilities, you can check the \r\ndetailed **documentation** [here](docs/) and more examples [here](docs/examples.py).\r\n\r\n## Tests\r\n\r\nYou can test the application by running ``python -m tests``\r\n\r\n## Contributing\r\n\r\nPull requests are welcome. Do not hesitate to open an issue if you have any problem or suggestion.\r\n\r\n## License\r\n\r\nThis project is under the MIT License.\r\n\r\n## Author\r\n\r\n<a href=\"https://github.com/icepick4\"><img src=\"https://avatars.githubusercontent.com/u/82316285?v=4\" width=\"100px;\" alt=\"Remi Jara\"/><br /><sub><b>Remi Jara</b></sub></a>\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A package to use the One-Piece API : https://api-onepiece.com/",
"version": "2.0",
"project_urls": {
"Homepage": "https://github.com/icepick4/onepyece"
},
"split_keywords": [
"one-piece",
"api",
"wrapper",
"onepyece",
"onepiece",
"onepiece-api",
"onepiece-api-wrapper",
"manga",
"anime",
"anime-manga"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa37475ca9f27e529366e30804d1af37f0cea5d4be805bba0cb04a7378799fc1",
"md5": "da062a69673e45179a52ad3d7f6d9c99",
"sha256": "f7cc2a5dcbc31b3bb7aee743a0decd94dd580f21c00f819fc08aba3ff06968ff"
},
"downloads": -1,
"filename": "onepyece-2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da062a69673e45179a52ad3d7f6d9c99",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9981,
"upload_time": "2024-02-02T13:18:51",
"upload_time_iso_8601": "2024-02-02T13:18:51.762054Z",
"url": "https://files.pythonhosted.org/packages/aa/37/475ca9f27e529366e30804d1af37f0cea5d4be805bba0cb04a7378799fc1/onepyece-2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a1d5859491e57ef60e8cf2a9867469cbb063255eac9d21b35b959635ec70e484",
"md5": "fd1147b91d696925c7f4ced6427719e6",
"sha256": "1a31f7531ba7ba7a81bf61ae069b2117d086373d7f64793dda0533686c65d7ce"
},
"downloads": -1,
"filename": "onepyece-2.0.tar.gz",
"has_sig": false,
"md5_digest": "fd1147b91d696925c7f4ced6427719e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12541,
"upload_time": "2024-02-02T13:18:53",
"upload_time_iso_8601": "2024-02-02T13:18:53.440113Z",
"url": "https://files.pythonhosted.org/packages/a1/d5/859491e57ef60e8cf2a9867469cbb063255eac9d21b35b959635ec70e484/onepyece-2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-02 13:18:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "icepick4",
"github_project": "onepyece",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": []
}
],
"lcname": "onepyece"
}
JSON
