Skip to main content

A package to use the One-Piece API : https://api-onepiece.com/

Project description

One Pyece

Image generated with Midjourney.

PyPI - Python Version PyPI GitHub Workflow Status PyPI - License GitHub last commit

forthebadge forthebadge

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 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
  • 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

>>> 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 and more examples here.

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

Remi Jara
Remi Jara

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

onepyece-2.0.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

onepyece-2.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file onepyece-2.0.tar.gz.

File metadata

  • Download URL: onepyece-2.0.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.4

File hashes

Hashes for onepyece-2.0.tar.gz
Algorithm Hash digest
SHA256 1a31f7531ba7ba7a81bf61ae069b2117d086373d7f64793dda0533686c65d7ce
MD5 fd1147b91d696925c7f4ced6427719e6
BLAKE2b-256 a1d5859491e57ef60e8cf2a9867469cbb063255eac9d21b35b959635ec70e484

See more details on using hashes here.

File details

Details for the file onepyece-2.0-py3-none-any.whl.

File metadata

  • Download URL: onepyece-2.0-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.4

File hashes

Hashes for onepyece-2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f7cc2a5dcbc31b3bb7aee743a0decd94dd580f21c00f819fc08aba3ff06968ff
MD5 da062a69673e45179a52ad3d7f6d9c99
BLAKE2b-256 aa37475ca9f27e529366e30804d1af37f0cea5d4be805bba0cb04a7378799fc1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page