Installation

Following Sections provide overview on how to install the package.

Latest Stable Version

$ pip install tessif

Latest Development Version (potentially unstable)

$ pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ tessif

This installs the TestPyPI version of tessif while resolving the dependencies on PyPI.

Development

Use the following advice to install the developer version of this package.

Linux

  1. You need Python 3.8+ (Pyenv is hightly recommended for multiple verions)

  2. Install Poetry and Nox and Nox-Poetry

  3. Clone the repo to a local directory (uses package name if square bracket part is omitted):

    $ git clone https://github.com/tZ3ma/tessif [tessif-develop]
    
  4. Install the package with development requirements:

    $ poetry install
    
  5. Auto generate and activate a virtual environment where the installed package is installed:

    $ poetry shell