Check It Out (CzekItOut)

czekitout is a Python library that contains a collection of functions that facilitate validation, and type-conversions, with useful error messages when exceptions are thrown.

Visit the czekitout website for a web version of the installation instructions, the reference guide, and the examples archive.

The source code can be found in the czekitout GitHub repository.

Table of contents

• Instructions for installing and uninstalling czekitout
  • Installing czekitout
    • Installing czekitout using pip
    • Installing czekitout using conda
  • Uninstalling czekitout
• Learning how to use czekitout

Instructions for installing and uninstalling czekitout

Installing czekitout

For all installation scenarios, first open up the appropriate command line interface. On Unix-based systems, you could open e.g. a terminal. On Windows systems you could open e.g. an Anaconda Prompt as an administrator.

Installing czekitout using pip

Before installing czekitout, make sure that you have activated the (virtual) environment in which you intend to install said package. After which, simply run the following command:

pip install czekitout

The above command will install the latest stable version of czekitout.

To install the latest development version from the main branch of the czekitout GitHub repository, one must first clone the repository by running the following command:

git clone https://github.com/mrfitzpa/czekitout.git

Next, change into the root of the cloned repository, and then run the following command:

pip install .

Note that you must include the period as well. The above command executes a standard installation of czekitout.

Optionally, for additional features in czekitout, one can install additional dependencies upon installing czekitout. To install a subset of additional dependencies (along with the standard installation), run the following command from the root of the repository:

pip install .[<selector>]

where <selector> can be one of the following:

• tests: to install the dependencies necessary for running unit tests;
• examples: to install the dependencies necessary for executing files stored in <root>/examples, where <root> is the root of the repository;
• docs: to install the dependencies necessary for documentation generation;
• all: to install all of the above optional dependencies.

Alternatively, one can run:

pip install czekitout[<selector>]

elsewhere in order to install the latest stable version of czekitout, along with the subset of additional dependencies specified by <selector>.

Installing czekitout using conda

To install czekitout using the conda package manager, run the following command:

conda install -c conda-forge czekitout

The above command will install the latest stable version of czekitout.

Uninstalling czekitout

If czekitout was installed using pip, then to uninstall, run the following command:

pip uninstall czekitout

If czekitout was installed using conda, then to uninstall, run the following command:

conda remove czekitout

Learning how to use czekitout

For those new to the czekitout library, it is recommended that they take a look at the Examples page, which contain code examples that show how one can use the czekitout library. While going through the examples, readers can consult the czekitout reference guide to understand what each line of code is doing.