Skip to main content

A client library for accessing Jikan API

Project description

jikan-api-client

NOTE: Docs are partly autogenerated -- this is all placeholder for now

A client library for accessing Jikan API

Usage

First, create a client:

from jikan_api_client import Client

client = Client(base_url="https://api.example.com")

Now call your endpoint and use your models:

from jikan_api_client.models import MyDataModel
from jikan_api_client.api.my_tag import get_my_data_model
from jikan_api_client.types import Response

my_data: MyDataModel = get_my_data_model.sync(client=client)
# or if you need more info (e.g. status_code)
response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)

Or do the same thing with an async version:

from jikan_api_client.models import MyDataModel
from jikan_api_client.api.my_tag import get_my_data_model
from jikan_api_client.types import Response

my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)

Things to know:

  1. Every path/method combo becomes a Python module with four functions:

    1. sync: Blocking request that returns parsed data (if successful) or None
    2. sync_detailed: Blocking request that always returns a Request, optionally with parsed set if the request was successful.
    3. asyncio: Like sync but the async instead of blocking
    4. asyncio_detailed: Like sync_detailed by async instead of blocking
  2. All path/query params, and bodies become method arguments.

  3. Any endpoint which did not have a tag will be in jikan_api_client.api.default

Building / publishing this Client

This project uses Poetry to manage dependencies and packaging. Here are the basics:

  1. Update the metadata in pyproject.toml (e.g. authors, version)
  2. If you're using a private repository, configure it with Poetry
    1. poetry config repositories.<your-repository-name> <url-to-your-repository>
    2. poetry config http-basic.<your-repository-name> <username> <password>
  3. Publish the client with poetry publish --build -r <your-repository-name> or, if for public PyPI, just poetry publish --build

If you want to install this client into another project without publishing it (e.g. for development) then:

  1. If that project is using Poetry, you can simply do poetry add <path-to-this-client> from that project
  2. If that project is not using Poetry:
    1. Build a wheel with poetry build -f wheel
    2. Install that wheel from the other project pip install <path-to-wheel>

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

jikanpy-v4-alpha-0.0.1.tar.gz (76.3 kB view details)

Uploaded Source

Built Distribution

jikanpy_v4_alpha-0.0.1-py3-none-any.whl (304.3 kB view details)

Uploaded Python 3

File details

Details for the file jikanpy-v4-alpha-0.0.1.tar.gz.

File metadata

  • Download URL: jikanpy-v4-alpha-0.0.1.tar.gz
  • Upload date:
  • Size: 76.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.2 Linux/5.16.16-arch1-1

File hashes

Hashes for jikanpy-v4-alpha-0.0.1.tar.gz
Algorithm Hash digest
SHA256 e9ec43865a31e40c08bbf005572ffad53556e2f45858d953b531785cd467bac3
MD5 cdeeeedada29191d75b0be3316315d33
BLAKE2b-256 75f751245126dd097a42bf88ff5265c859594333d3f695107e4b9c2c23c09a27

See more details on using hashes here.

File details

Details for the file jikanpy_v4_alpha-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: jikanpy_v4_alpha-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 304.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.2 Linux/5.16.16-arch1-1

File hashes

Hashes for jikanpy_v4_alpha-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 70e48a4af26cab6c7141408274293848c7d01634a53ac6afd0b8d9c46a11dabe
MD5 ef3b82e14fc81491900a44f6ac57dc6f
BLAKE2b-256 a2ba9f43299eb9ce2406270b10982c57f6d517039ecd7d5f26062e0425fccbf8

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