This release is a pre-release and may not be stable for production use.
Nadeshiko SDK
Python SDK for the Nadeshiko API.
Install
pip install nadeshiko-sdk
Use the public SDK
The client sends your API key as Authorization: Bearer <apiKey>.
import os
from nadeshiko import Nadeshiko
from nadeshiko.api.search import search
from nadeshiko.models import Error, SearchRequest
client = Nadeshiko(
base_url=os.getenv("NADESHIKO_BASE_URL", "https://api.nadeshiko.co"),
token=os.getenv("NADESHIKO_API_KEY", "your-api-key"),
)
result = search.sync(
client=client,
body=SearchRequest(query="彼女"),
)
if isinstance(result, Error):
print(result.code, result.detail)
else:
for sentence in result.sentences:
print(sentence.segment_info.content_jp)
Error handling
Every response returns either a typed response object or an Error. The Error object follows the RFC 7807 Problem Details format, so you always get a machine-readable code and a human-readable detail.
import os
from nadeshiko import Nadeshiko
from nadeshiko.api.search import search
from nadeshiko.models import Error, SearchRequest
client = Nadeshiko(
base_url=os.getenv("NADESHIKO_BASE_URL", "https://api.nadeshiko.co"),
token=os.getenv("NADESHIKO_API_KEY", "your-api-key"),
)
result = search.sync(
client=client,
body=SearchRequest(query="食べる"),
)
if isinstance(result, Error):
match result.code:
# 400 — Bad Request
case "VALIDATION_FAILED":
print("Validation failed:", result.detail)
case "INVALID_JSON":
print("Malformed JSON body:", result.detail)
case "INVALID_REQUEST":
print("Invalid request:", result.detail)
# 401 — Unauthorized
case "AUTH_CREDENTIALS_REQUIRED":
print("Missing API key or session token")
case "AUTH_CREDENTIALS_INVALID":
print("API key is invalid")
case "AUTH_CREDENTIALS_EXPIRED":
print("Token has expired, re-authenticate")
case "EMAIL_NOT_VERIFIED":
print("Email verification required")
# 403 — Forbidden
case "ACCESS_DENIED":
print("Access denied")
case "INSUFFICIENT_PERMISSIONS":
print("API key lacks the required scope")
# 429 — Too Many Requests
case "RATE_LIMIT_EXCEEDED":
print("Rate limit hit, slow down")
case "QUOTA_EXCEEDED":
print("Monthly quota exhausted")
# 500 — Internal Server Error
case "INTERNAL_SERVER_EXCEPTION":
print("Server error, trace ID:", result.instance)
else:
for sentence in result.sentences:
print(sentence.segment_info.content_jp, "—", sentence.basic_info.name_anime_en)
See examples/examples.py for more usage patterns.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nadeshiko_internal_sdk-1.5.0.dev1772304387.tar.gz.
File metadata
- Download URL: nadeshiko_internal_sdk-1.5.0.dev1772304387.tar.gz
- Upload date:
- Size: 99.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7eed41961052e2b2f20b7d8a7e85bc363b5d1f59f74a0fef9bafdb9fcc8d8b89
|
|
| MD5 |
1bc9838f7182d09bee1d2035d92386e3
|
|
| BLAKE2b-256 |
4a3708d6922b511355b61f1f950fb5a01eccb2b5bbf0108024bd67ec700bed6b
|
Provenance
The following attestation bundles were made for nadeshiko_internal_sdk-1.5.0.dev1772304387.tar.gz:
Publisher:
release.yml on BrigadaSOS/nadeshiko-sdk-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
nadeshiko_internal_sdk-1.5.0.dev1772304387.tar.gz -
Subject digest:
7eed41961052e2b2f20b7d8a7e85bc363b5d1f59f74a0fef9bafdb9fcc8d8b89 - Sigstore transparency entry: 1005144353
- Sigstore integration time:
-
Permalink:
BrigadaSOS/nadeshiko-sdk-python@80a7ec07f1f5a585ce2096a3874d02ffc2209272 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/BrigadaSOS
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@80a7ec07f1f5a585ce2096a3874d02ffc2209272 -
Trigger Event:
repository_dispatch
-
Statement type:
File details
Details for the file nadeshiko_internal_sdk-1.5.0.dev1772304387-py3-none-any.whl.
File metadata
- Download URL: nadeshiko_internal_sdk-1.5.0.dev1772304387-py3-none-any.whl
- Upload date:
- Size: 344.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
32f07d48d12bfd5f5319930605816a20f18064e59d68f8957ce3d4e97c6864a8
|
|
| MD5 |
ed438c5fd9a271d68d02db5e8d4d66c7
|
|
| BLAKE2b-256 |
a9ec14ba876e1312229e1489ece487832412be9d981419d18b96e3dec3d0002a
|
Provenance
The following attestation bundles were made for nadeshiko_internal_sdk-1.5.0.dev1772304387-py3-none-any.whl:
Publisher:
release.yml on BrigadaSOS/nadeshiko-sdk-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
nadeshiko_internal_sdk-1.5.0.dev1772304387-py3-none-any.whl -
Subject digest:
32f07d48d12bfd5f5319930605816a20f18064e59d68f8957ce3d4e97c6864a8 - Sigstore transparency entry: 1005144358
- Sigstore integration time:
-
Permalink:
BrigadaSOS/nadeshiko-sdk-python@80a7ec07f1f5a585ce2096a3874d02ffc2209272 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/BrigadaSOS
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@80a7ec07f1f5a585ce2096a3874d02ffc2209272 -
Trigger Event:
repository_dispatch
-
Statement type:
