jwlib 1.0.0b1

Wrapper for jw.org APIs

Python wrappers for a few JW.ORG APIs.

• Documentation: https://jwlib.readthedocs.io.

Note

This is project is currently in beta stage.

Installation

This is the preferred method to install jwlib is using pip, as it will always install the most recent stable release.

$ pip install jwlib

Usage

TODO

Development

Download the source code from the repo or by using git.

$ git clone git://github.com/allejok96/jwlib

jwlib uses hatch as its build system and it comes with some nice features, but it’s not strictly needed. If you want to take a simpler approach using regular old venv you can stop right here.

Otherwise let’s go ahead and install hatch. Here’s one way you can do it:

$ pip install --user pipx
$ pipx ensurepath
$ pipx install hatch

Then do a test run to download all dependencies and create a virtual environment.

$ cd jwlib
$ hatch run test

If you’re using an IDE like PyCharm probably want to configure it to use the virtual environment that hatch just created. You can find it somewhere in the hatch data directory. On Linux this will be something like ~/.local/share/hatch/env/virtual/jwlib/3onyU7Va/jwlib.

Now if you want to run a command from the terminal in the virtual environment you have to do it like so:

$ hatch run python somefile.py

When you’re satisfied with your changes, run the tests again.

$ hatch run test

This will probably fail because jwlib uses pytest-recording to record all interactions with the server and store them offline for testing. If the code tries to make a request that has not been recorded, the test will fail. In that case you must update the cassettes using the command below (this might take a while).

$ hatch run record

A list of other development related commands can be obtained with:

$ hatch run help