Quick Start

This section covers steps for installation and a guide on how to use.

How to Install?

There are two approaches to install the package:

  • Manually cloning the project in Github repository: statesxt

  • Using pip, that the package is hosted in here (recommended). Currently, due to the Pypi repository being down and is blocking any account registers and project uploads, the package is now hosted on TestPypi for the time being.

    pip install -i https://test.pypi.org/simple/ statesxt

Tip

It is always better to install the package in a virtual environment.

How to Use?

  • Generate the template

    statesxt gen

  • Remove the template

    statesxt rem

How to Update?

Currently, the package can not be updated through usual command pip install --upgrade statesxt. Probably because is hosted in TestPypi. So, for the time being, user have to reinstall the package.

How to Uninstall?

There are two approaches to uninstall the package:

  • Uninstalling only the package

    pip uninstall statesxt

  • Uninstalling the package and its dependencies (vulnerable). To do this, the user must install a package called pip-autoremove (if not already installed).

    pip install pip-autoremove

    Once the package is installed, user can now uninstall the package with the following command.

    pip-autoremove statesxt -y

    Note

    If there is an error saying that ModuleNotFoundError: No module named 'pip_autoremove', you could try to move the pip_autoremove.py file from ./Scripts into ./Lib instead.

    For further information: https://stackoverflow.com/questions/74523001/modulenotfounderror-when-trying-to-use-pip-autoremove