Installation

Following Sections provide overview on how to install the package.

Standard/User Install

Use the following advice to install the standard / user version of this package, once you have at least one push on your main and develop branch (so the respective release workflows are triggered).

Linux

Install using a console with your virtual environment activated:

Latest Stable Version

$ pip install strutils

Latest Development Version (potentially unstable)

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

This installs the TestPyPI version of MY-PROJECT while resolving the dependencies on PyPI.

Development Install

  1. Install Pyenv (only if not already present)

  2. Install Poetry and Nox (only if not already present)

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

    $ git clone https://github.com/tZ3ma/strutils [strutils-develop]

  4. Change to the new local repo folder and activate the desired python versions using pyenv:

    $ cd strutils

$ pyenv install 3.10.4 (adjust version to your needs)
$ pyenv install 3.9.13 (optional)
$ pyenv install 3.8.13 (optional)

$ pyenv local 3.10.4 3.9.13 3.8.13 (activate those desired)

  5. Install the package with development requirements:

    $ poetry install
56 Auto generate and activate a virtual environment where the installed package

is installed:

$ poetry shell

  1. (Optional) Alternatively, you can now run an interactive Python session, or the command-line interface if your package supports it:

    $ poetry run python
$ poetry run strutils