Installation and Usage¶
For package description see README.rst file
Installation (System wide - for all users):¶
Note
In case of using Python 3 on linux system replace pip
with pip3
and python
with python3
in below commands.
Prerequisites¶
This program requires following 3-rd party packages: PyYAML
, lxml
.
They must be installed in order to run Datconv.
In addition JSON readers require ijson
package to be installed.
sudo pip install PyYAML ijson
pip install PyYAML ijson
Installation Method 1¶
sudo pip install datconv
pip install datconv
Installation Method 2¶
sudo pip install datconv-<ver>.tar.gz
pip install datconv-<ver>.tar.gz
Installation Method 3¶
sudo python setup.py install
python setup.py install
Note
More installation options are possible - see documentation of Python distutils
package.
Installation from Source¶
If you have downloaded archive snapshot, first unpack it and from root folder run command:
python setup.py sdist
which will create dist
subfolder and create source-ball in it. Then apply method 2 or 3 above.
Files deployed by installation script¶
- Main command line utility:
Linux:<BINDATA>/datconv
, where<BINDATA>
is by default/usr/local/bin
Windows:<BINDATA>\Scripts\datconv-run.py
, where<BINDATA>
is by defaultC:\Program Files\PythonXX
where XX is Python version datconv
package and its sub-packages- Documentation:
Linux:<PREFIX>/share/doc/datconv/*
, where<PREFIX>
is by default/usr/local
Windows:<PREFIX>\doc\datconv\*
, where<PREFIX>
is by defaultC:\Program Files\PythonXX
Re-Installation / Upgrade¶
[sudo] pip install -U PyYAML datconv
.Note
if you upgrade from previous pandata/datconv version check Upgrade.rst
file deployed in documentation folder.
Usage:¶
Please refer to on-line or deployed documentation and Pydoc accesible information contained in this package.
Consider also installing datconv_tests
package which contain test scripts for this package.
It can also be used as source of samples of how this package may be used.
Additional configuration for Pydoc¶
There are some pydoc descriptions in several script files that are installed into folders not in python module search path, therefore standard pydoc browser would not get those descriptions. It is however possible to hack that: Linux: edit /usr/bin/pydoc file:
- at begin add:
import sys
- before
pydoc.gui()
call, addsys.path.append('/usr/local/bin')
- create symlink:
sudo ln -s /usr/local/bin/datconv /usr/local/bin/datconv-run.py
.
Windows: edit C:\Program Files\PythonXX\Tools\Scripts\pydocgui.pyw
file:
- at begin add:
import sys
- before
pydoc.gui()
call, addsys.path.append('C:\\Program Files\\PythonXX\\Scripts')
Obtaining Pydoc information¶
pydoc -g
pydoc3 -b
Note
This URL does not work with Windows IE browser.
/usr/local/lib/pythonX.X/dist-packages/
, /usr/local/bin
C:\Program Files\PythonXX\Lib\site-packages
, C:\Program Files\PythonXX\Scripts
and go into datconv(package)
or datconv-run
link.