How to Install doxx on Windows

doxx on Windows

In order to run doxx, you need to have the Python interpreter on your machine. Unfortunately, Windows does not come with a Python install by default (yet!). But fear not, the process to install it is incredibly simple.

Here are the steps.

Step 1: Download the Python Installer

Download the release version of the MSI installer from the Python Windows downloads page. You can install either Python version 2 (2.7.9 at the time of this post) or 3 (3.4.3 at the time of this post). doxx works with both Python interpreters. Use the Windows x86 MSI Installer unless you know that you have a 64 bit architecture (in which case you should download the Windows x86-64 MSI Installer).

Step 2: Install Python

Locate the installer file and double click on it. This will launch an install wizard that guides you through the installation steps. During the install, follow these steps:

  • keep the default install path C:\Python27\ or C:\Python34\
  • click the dropdown next to the menu item Add python.exe to Path and activate this
  • click the dropdown next to the word pip and select Will be installed on local hard drive

Click through the remainder of the install wizard and complete the Python install on your system.

Step 3: Command Line Time

Open your Windows terminal by pressing the keys Win-R, typing cmd, and then pressing the Enter key. You now have access to your command line.

Confirm your Python install by entering the following on the command line:

python --version

If your install took place and the PATH was appropriately set, this command should print the version of Python that you just installed.

Keep that command line open and head to the next step.

Step 4: Install doxx

If you followed the instructions above, pip was installed along with the Python interpreter. pip is a Python package manager that pulls Python packages that are released on the Python Package Index (commonly known as PyPI) to your machine. It so happens that doxx is one of over 50,000 packages hosted on PyPI. With pip, installs from PyPI are simple.

Install doxx with the following command:

pip install doxx

You will see install process reporting in the standard output of the terminal followed by a confirmation that the install took place without issues.

Confirm your doxx install with the command:

doxx --version

The current release version of doxx should be displayed in your terminal.

You’re all set. Head to the doxx documentation or check out other tutorials to get started.

doxx Upgrades After Your Install

For future reference, you can upgrade to a new version of doxx with the following pip command:

pip install --upgrade doxx

The current doxx release version is displayed on the main documentation page and new version announcements are posted to @doxxapp on Twitter. The changelog has details about what was included in each release.