Installation¶

Stable release¶

First of all, you want to make sure you have python and pipx installed on your device. It would also be preferable to have pyenv installed, in case the system interpreter is upgraded, as an example.

python¶

Here are a few Python installation guides (it’s quick):

pipx & (optional) pyenv¶

pipx¶

On macOS:

brew install pipx
pipx ensurepath

Otherwise, install via pip (requires pip 19.0 or later):

python3 -m pip install --user pipx
python3 -m pipx ensurepath

pyenv¶

The pyenv install is optional, mostly because the installation may be a hassle for non-devs. Non-devs should simply make sure to use a Python version larger than or equal to 3.11.0.

On MacOS:

brew update
brew install pyenv

You should also setup your shell environment.

On Linux:

curl https://pyenv.run | bash

Pyenv does not support Windows unless on WSL, which is Linux!

cryptoolz¶

The best way to install cryptoolz after this, for regular users, is as follows:

pipx install --suffix <cryptoolz version> cryptoolz

We want to essentially be absolutely sure that our local installation is always able to decrypt some data, so instead of updating cryptoolz we should simply always have a fresh install with a new suffix. As such, we never upgrade once downloaded versions.

This does not mean that the library won’t be backwards compatible, but this is simply the safest option for regular users.

If using pyenv, you might also want to install a fixed version and then, in bash, as an example:

pyenv shell <python version installed>
pipx install --suffix <python version installed> cryptoolz
pyenv shell $(pyenv global) # or just exit and open a new shell

Instead when using cryptoolz as a library the regular:

pip install cryptoolz

Is used as usual.

From sources¶

The sources for cryptoolz can be downloaded from the Codeberg repo.

You can clone the public repository:

git clone git://codeberg.com/tanats_nir/cryptoolz