Installation¶
Released versions of punx are available on PyPI.
If you have pip
installed, then you can install:
$ pip install punx
The latest development versions of punx can be downloaded from the GitHub repository listed above:
$ cd /some/directory
$ git clone http://github.com/prjemian/punx.git
To install in the standard Python location:
$ cd punx
$ pip install .
# -or-
$ python setup.py install
To install in user’s home directory:
$ python setup.py install --user
To install in an alternate location:
$ python setup.py install --prefix=/path/to/installation/dir
Updating¶
- pip
If you have installed previously with pip:
$ pip install -U --no-deps punx
- git
assuming you have cloned as shown above:
$ cd /some/directory/punx $ git pull $ pip install -U --no-deps .
Required Packages¶
It may be necessary to install some prerequisite packages in your python installation. If you are using an Anaconda python distribution, it is advised to install these pre-requisites using conda rather than pip. The pre-requisites include:
h5py
lxml
numpy
Qt and PyQt (either v4 or v5)
requests
PyGithub
See your distribution’s documentation for how to install these. With Anaconda, use:
conda install h5py lxml numpy Qt=5 PyQt=5 requests
pip install PyGitHub pyRestTable
Package |
URL |
---|---|
h5py |
|
lxml |
|
numpy |
|
PyGithub |
|
PyQt4 |
|
requests |
Optional Packages¶
Package |
URL |
---|---|
pyRestTable |
- The pyRestTable package is used for various reports in the punx application.
If using the punx package as a library and developing your own custom reporting, this package is not required.