| Name | jwlib JSON |
| Version |
1.0.0b1
JSON |
| download |
| home_page | None |
| Summary | Wrapper for jw.org APIs |
| upload_time | 2024-11-02 19:59:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
jw
jworg
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
=====
jwlib
=====
.. image:: https://img.shields.io/pypi/v/jwlib.svg
:target: https://pypi.python.org/pypi/jwlib
.. image:: https://img.shields.io/travis/allejok96/jwlib.svg
:target: https://travis-ci.com/allejok96/jwlib
.. image:: https://readthedocs.org/projects/jwlib/badge/?version=latest
:target: https://jwlib.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
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.
.. code-block:: console
$ pip install jwlib
-----
Usage
-----
.. code-block:: console
TODO
------------
Development
------------
Download the source code from the `repo`_ or by using git.
.. code-block:: console
$ 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:
.. code-block:: console
$ pip install --user pipx
$ pipx ensurepath
$ pipx install hatch
Then do a test run to download all dependencies and create a virtual environment.
.. code-block:: console
$ 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:
.. code-block:: console
$ hatch run python somefile.py
When you're satisfied with your changes, run the tests again.
.. code-block:: console
$ 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).
.. code-block:: console
$ hatch run record
A list of other development related commands can be obtained with:
.. code-block:: console
$ hatch run help
.. _JW.ORG: https://www.jw.org/
.. _hatch: https://hatch.pypa.io/dev/install
.. _repo: https://github.com/allejok96/jwlib
.. _hatch data directory: https://hatch.pypa.io/dev/config/hatch/#data
.. _pytest-recording: https://github.com/kiwicom/pytest-recording
Raw data
{
"_id": null,
"home_page": null,
"name": "jwlib",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "jw, jworg",
"author": null,
"author_email": "allejok96 <allejok96@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e1/47/3003937d25c753594582ab16c37d77a663e579a71808a2f1a14d12ac8996/jwlib-1.0.0b1.tar.gz",
"platform": null,
"description": "=====\njwlib\n=====\n\n\n.. image:: https://img.shields.io/pypi/v/jwlib.svg\n :target: https://pypi.python.org/pypi/jwlib\n\n.. image:: https://img.shields.io/travis/allejok96/jwlib.svg\n :target: https://travis-ci.com/allejok96/jwlib\n\n.. image:: https://readthedocs.org/projects/jwlib/badge/?version=latest\n :target: https://jwlib.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n\nPython wrappers for a few JW.ORG_ APIs.\n\n* Documentation: https://jwlib.readthedocs.io.\n\n\n.. note::\n\n This is project is currently in beta stage.\n\n------------\nInstallation\n------------\n\nThis is the preferred method to install jwlib is using pip, as it will always install the most recent stable release.\n\n.. code-block:: console\n\n $ pip install jwlib\n\n-----\nUsage\n-----\n\n.. code-block:: console\n\n TODO\n\n------------\nDevelopment\n------------\n\nDownload the source code from the `repo`_ or by using git.\n\n.. code-block:: console\n\n $ git clone git://github.com/allejok96/jwlib\n\njwlib uses `hatch`_ as its build system and it comes with some nice features, but it's not strictly needed.\nIf you want to take a simpler approach using regular old `venv` you can stop right here.\n\nOtherwise let's go ahead and install `hatch`_. Here's one way you can do it:\n\n.. code-block:: console\n\n $ pip install --user pipx\n $ pipx ensurepath\n $ pipx install hatch\n\nThen do a test run to download all dependencies and create a virtual environment.\n\n.. code-block:: console\n\n $ cd jwlib\n $ hatch run test\n\nIf you're using an IDE like PyCharm probably want to configure it to use the virtual environment that hatch just\ncreated. You can find it somewhere in the `hatch data directory`_. On Linux this will be something like\n`~/.local/share/hatch/env/virtual/jwlib/3onyU7Va/jwlib`.\n\nNow if you want to run a command from the terminal in the virtual environment you have to do it like so:\n\n.. code-block:: console\n\n $ hatch run python somefile.py\n\nWhen you're satisfied with your changes, run the tests again.\n\n.. code-block:: console\n\n $ hatch run test\n\nThis will probably fail because jwlib uses `pytest-recording`_ to record all interactions with the server and store\nthem offline for testing. If the code tries to make a request that has not been recorded, the test will fail.\nIn that case you must update the cassettes using the command below (this might take a while).\n\n.. code-block:: console\n\n $ hatch run record\n\nA list of other development related commands can be obtained with:\n\n.. code-block:: console\n\n $ hatch run help\n\n.. _JW.ORG: https://www.jw.org/\n.. _hatch: https://hatch.pypa.io/dev/install\n.. _repo: https://github.com/allejok96/jwlib\n.. _hatch data directory: https://hatch.pypa.io/dev/config/hatch/#data\n.. _pytest-recording: https://github.com/kiwicom/pytest-recording",
"bugtrack_url": null,
"license": null,
"summary": "Wrapper for jw.org APIs",
"version": "1.0.0b1",
"project_urls": {
"Changelog": "https://github.com/allejok96/jwlib/blob/master/HISTORY.rst",
"Documentation": "https://readthedocs.org",
"Homepage": "https://github.com/allejok96/jwlib",
"Issues": "https://github.com/allejok96/jwlib/issues"
},
"split_keywords": [
"jw",
" jworg"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e8a1277231e8e174906dd22a334c42d2903e2c6a09903653fa561adb2eaf963a",
"md5": "6718b2fda413f29967e73ea91e7611a1",
"sha256": "7d5c0c724505f07c6fce8a704aafe58a4fcb78140d3a8e00e04190ffca04130a"
},
"downloads": -1,
"filename": "jwlib-1.0.0b1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6718b2fda413f29967e73ea91e7611a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 34611,
"upload_time": "2024-11-02T19:59:28",
"upload_time_iso_8601": "2024-11-02T19:59:28.302547Z",
"url": "https://files.pythonhosted.org/packages/e8/a1/277231e8e174906dd22a334c42d2903e2c6a09903653fa561adb2eaf963a/jwlib-1.0.0b1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e1473003937d25c753594582ab16c37d77a663e579a71808a2f1a14d12ac8996",
"md5": "9f07bfef6367682b6b159ffb83533909",
"sha256": "726fb9eab849f55e572aaec7a49bb2307662d4a011e1b3f0c9280593af812e9d"
},
"downloads": -1,
"filename": "jwlib-1.0.0b1.tar.gz",
"has_sig": false,
"md5_digest": "9f07bfef6367682b6b159ffb83533909",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5666034,
"upload_time": "2024-11-02T19:59:29",
"upload_time_iso_8601": "2024-11-02T19:59:29.952553Z",
"url": "https://files.pythonhosted.org/packages/e1/47/3003937d25c753594582ab16c37d77a663e579a71808a2f1a14d12ac8996/jwlib-1.0.0b1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-02 19:59:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "allejok96",
"github_project": "jwlib",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jwlib"
}
