Skip to content

Installing

WPextract is available on the PyPI and Anaconda package indexes.

The minimum supported Python version is 3.9. WPextract should work on any Python-supported operating system.

pipx will automatically install WPextract and its dependencies in an isolated yet globally-accessible environment.

We recommend this method for those wishing to use WPextract through its command line interface.

  1. If pipx is not already installed, follow the steps in the pipx installation instructions
  2. Install WPextract: 
    $ pipx install wpextract
  3. Test installation: 
    $ wpextract --help
Upgrading

To upgrade versions use: 

$ pipx upgrade wpextract

Multiple/Specific Versions

To install a specific version, use: 

$ pipx install wpextract==1.0.0
Multiple versions can be installed in parallel using suffixes: 
$ pipx install --suffix=@1.0.0 wpextract==1.0.0
$ pipx install --suffix=@1.1.0 wpextract==1.1.0
$ wpextract@1.0.0 --version
$ wpextract@1.1.0 --version
The suffix is user-specified and does not necessarily have to match the version number.

Uninstalling

To uninstall, use: 

$ pipx uninstall wpextract
This will cleanly uninstall the package and delete its environment

With pip or conda

To install within an existing environment, which is necessary to use WPextract as a library.

WPextract can be manually installed with:

$ pip install wpextract

$ conda install wpextract

The installation can be tested through the command-line interface:

$ wpextract --help

or through importing as a library:

>>> import wpextract
>>> wpextract.__version__
1.0.0

For Development

Dependencies for development and packaging are managed through Poetry.

Poetry will automatically install dependencies and the package itself in editable mode:

$ poetry install
$ poetry install --with docs # to build docs locally
$ wpextract --help