doxx Install Guide

doxx requires a Python install on your system and has been tested in current Python v2 and v3 releases. Many operating systems include Python by default. If you need to install Python, the current release is available in most package managers and downloads for all platforms are available here.

Windows users can refer to this page of the Python documentation for instructions on how to define the Python interpreter file path on your system.

Install doxx with pip

You can install doxx with the Python package manager, pip:

$ pip install doxx

and then confirm your install by checking the version number with the command:

$ doxx --version

pip is included in current Python releases. If you have a Python release that does not include pip, here are the pip install instructions.

Install doxx from Source

Alternatively, you can download the source code archive for the current release:

or clone the project directory with git:

$ git clone

If you downloaded a tar.gz or .zip file, unpack the archive. Navigate to the top level of the source directory. Then, enter the following command:

$ python install

Confirm your install by checking the version number with the command:

$ doxx --version

If the version is displayed, you're all set.

Upgrade doxx

Upgrade doxx with pip

To get the latest doxx release, enter the following pip command:

$ pip install --upgrade doxx

Upgrade doxx from Source

Follow the instructions shown above for a new install from the source code.


If you have problems with your doxx install, please see the issue reporting page.

just blimpin doxx documentation is licensed under the CC-4.0-Attribution LicenseImprove this page