CNLib

CNLib

“It mostly works” ™©®

A Python library containing useful functions and classes

Version 0.0.6

Table of Contents

• Requirements
• Downloading
• Installing
• Usage
• Uninstalling
• Notes

Requirements

Python 3.10+

Downloading

There are two ways to get the code:

1. Download the latest release (the ‘Source code (zip)’ file should work an all platforms).

2. 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

where <version> is the version number included in the file name.

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 documentation.

Uninstalling

In your project folder:

$ . .venv/bin/activate
$ python -m pip uninstall cnlib

Notes

10/10, no notes.

-)

This site is open source. Improve this page.