Code Monkey home page Code Monkey logo

py-jpdb's Introduction

py-jpdb

A Python 3 package providing a very limited and experimental client for jpdb, 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 with username and password instead of using the "Sign in with Google" option.

Example:

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.

Changes

All notable changes to this project will be documented in the file CHANGELOG.md.

Contributing

See the Contributing Guide for instructions on how to set up a local environment for development and testing.

License

MIT

py-jpdb's People

Contributors

github-actions[bot] avatar ustuehler avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.