https://github.com/ustuehler/py-jpdb
Python package providing an experimental client for https://jpdb.io
https://github.com/ustuehler/py-jpdb
api-client jpdb python
Last synced: 15 days ago
JSON representation
Python package providing an experimental client for https://jpdb.io
- Host: GitHub
- URL: https://github.com/ustuehler/py-jpdb
- Owner: ustuehler
- License: mit
- Created: 2022-08-24T09:08:55.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-28T11:31:09.000Z (over 3 years ago)
- Last Synced: 2025-12-26T22:48:13.802Z (5 months ago)
- Topics: api-client, jpdb, python
- Language: Python
- Homepage:
- Size: 264 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# py-jpdb
A Python 3 package providing a _very_ limited and experimental client for [jpdb](https://jpdb.io/), a powerful Japanese dictionary and all-in-one learning system.
## Features
- Validation of login credentials (`JPDB.login`)
- Get the total number of due items (`JPDB.due_items`)
- Export the entire review history (`JPDB.reviews`)
## Installation with pip
```
pip install git+https://github.com/ustuehler/py-jpdb
```
## Usage
You need an active user account on jpdb in order to use this client, and you
must [register](https://jpdb.io/register) with username and password instead of
using the "Sign in with Google" option.
Example:
```python
import os
from jpdb import JPDB
# Get the username and password from somewhere (NB: OAuth is not supported)
username = os.environ['JPDB_USERNAME']
password = os.environ['JPDB_PASSWORD']
# Create a jpdb client instance
jpdb = JPDB(username, password)
# Ensure that credentials are valid (optional)
jpdb.login()
# Do something useful
print(jpdb.due_items)
```
For other possible usages, please see the implementation of the `JPDB` class in
[jpdb/\_\_init\_\_.py](jpdb/__init__.py).
## Changes
All notable changes to this project will be documented in the file
[CHANGELOG.md](CHANGELOG.md).
## Contributing
See the [Contributing Guide](CONTRIBUTING.md) for instructions on how to set up
a local environment for development and testing.
## License
[MIT](LICENSE)