The PSDI Data Conversion service can be downloaded for local use. This is recommended when you wish to convert
sensitive, convert files exceeding the size limit for the public service, or access it via the command-line or
Python library.
Installation
Install via pip
The easiest way to install the project is via Python’s pip utility. If you do not already have this installed,
the readme in the link above provides details on installing Python and pip. If you do, you can install the
package via:
pip install psdi-data-conversion[gui]
The [gui] portion installs the optional requirements needed to run a local
version of this webpage, and can be excluded if you only intend to use the command-line application and/or
Python library.
Source Code
The project’s source code is available on GitHub at the link above. If you wish to install it from source, you
can clone the repository, and then install it via:
pip install .[gui-test]
The [gui-test] portion installs all optional components for running the local
webpage and testing all project components. See the project’s pyproject.toml file
for other possible optional dependencies sets that can be installed.
Use
Once installed, the project can be used in one of three ways:
- Local Gui: Run the script
psdi-data-convert-gui to start the
server. Append the --help option for to see optional arguments (generally not
required for end-users)
- Command-Line Application: Run the script
psdi-data-convert
to use the application at the command-line. Append the --help option to see
arguments for it, and/or find documentation in the project’s README.
- Python Library: Within a Python script, library, or terminal, the project can be imported
via
import psdi_data_conversion, with the most useful function being psdi_data_conversion.converter.run_converter - see the help() of this function and/or find documentation in the project’s README.
Documentation
