getBible/librarian
5
0
Fork 0
Code Issues
Our go-to tool for retrieving Bible references with ease.
9 Commits 2 Branches 0 Tags 143 KiB
Python 100%
a2b95224b1
Go to file
Llewellyn van der Merwe a2b95224b1
Adds better build path.
2023-11-14 11:09:01 +02:00
.github/workflows Adds better build path. 2023-11-14 11:09:01 +02:00
docs adds getBible class to select scripture. 2023-11-13 08:18:25 +02:00
src/getbible Removes the walrus operator so we can also use Python 3.7 2023-11-14 07:58:20 +02:00
tests Adds efficient data retrieval, query optimization, for server performance. Streamlines the caching mechanism and ensures that the methods are efficient and robust. Clear the caching once a month to keep scripture in sync with API. Adds workflow testing. 2023-11-14 07:50:20 +02:00
.gitignore first commit 2023-11-11 20:52:13 +02:00
LICENSE first commit 2023-11-11 20:52:13 +02:00
pyproject.toml Adds better build path. 2023-11-14 11:09:01 +02:00
README.md Adds stable librarian workflow. 2023-11-14 08:03:10 +02:00
requirements.txt Adds better build path. 2023-11-14 11:09:01 +02:00
setup.py Adds better build path. 2023-11-14 11:09:01 +02:00

README.md

getBible Librarian

Stable Librarian

The getBible Librarian package is a Python library designed for efficiently retrieving the scripture reference across various translations.

Features

Installation (pip)

To install the package using pip, see the documentation.

Installation (git)

To install getBible-Librarian, you need to clone the repository and install the package manually. Ensure you have Python 3.7 or higher installed.

git clone https://git.vdm.dev/getBible/librarian.git
cd librarian
pip install .

Development and Testing

To contribute or run tests, clone the repository and set up a virtual environment:

git clone https://git.vdm.dev/getBible/librarian.git
cd librarian
python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`
pip install -e .

Run tests using the standard unittest framework:

python -m unittest

Contributing

Contributions to the getBible-Librarian package are welcome. Please ensure to follow the coding standards and write tests for new features.

License

This project is licensed under the GNU GPL v2.0. See the LICENSE file for more details.