CLI_Test

"It mostly works" ™©®

License: WTFPLv2

Version 0.0.0

Shirt description

Table of Contents

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/CLI_Test

Installing

There are also two ways to get CLI_Test 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/CLI_Test-<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/CLI_Test

Automagically

Add this line to your project's 'requirements.txt' file:

CLI_Test @ git+https://github.com/cyclopticnerve/CLI_Test@<tag>

where \<tag> is the tag you want, such as 'v0.0.1', etc.

Then run:

$ python -m pip install -r requirements.txt

If you downloaded the zip file, extract it and go to the 'install' directory:

$ cd ~/Downloads/CLI_Test-<version>/install

where \<version> is the version number of the file you downloaded.

If you cloned the repo, just go to the 'install' directory:

$ cd ~/Downloads/CLI_Test/install

Either way, run the install script:

$ ./install.py

Usage

blah blah blah

Uninstalling

In your project folder:

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

Go to the source folder for CLI_Test and run the uninstaller:

$ cd ~/.local/share/cli_test/uninstall
$ ./uninstall.py

Documentation

See the documentation

Notes

blah blah blah

-)