CNLib
"It mostly works" ™©®
A Python library containing useful functions and classes
Version 1.2.0
Table of Contents
Requirements
Downloading
There are two ways to get the code:
-
Download the latest release (the 'cnlib-\<version>.zip' file should work on all platforms).
-
Or you can clone the git repo to get the latest (and often broken) code from the main branch:
$ git clone https://github.com/cyclopticnerve/CNLib
Installing
There are also two ways to get CNLib into your project.
Run these commands from your project directory.
First make sure you have a venv and it is active:
$ python -m venv .venv
$ . .venv/bin/activate
Manually
If you downloaded the zip file:
$ python -m pip install /path/to/cnlib-<version>.zip
Or if you cloned the repo:
$ python -m pip install /path/to/CNLib
Automagically
Add this line to your project's 'requirements.txt' file:
CNLib @ git+https://github.com/cyclopticnerve/CNLib@<tag>
where \<tag> is the tag you want, such as 'v0.0.1', etc.
Then run:
$ python -m pip install -r requirements.txt
Usage
Read the full documentation.
Uninstalling
In your project folder:
$ . .venv/bin/activate
$ python -m pip uninstall cnlib
Documentation
See the full documentation.
Developing
If you are developing this project, make sure you run the "develop.py" script first to create the proper virtual environment and install the requirements (if any).
Notes
10/10, no notes.
-)