xopp2py/README.md

33 lines
627 B
Markdown

# Python interface to Xournal++ (.xopp) file format
## Packages
This project contains the following packages, under `src`:
- xopp2py
- xopp2oml
### xopp2py
Python interface to .xopp (Xournal++)
Dependencies: Python3
### xopp2oml
XOPP to OML converter
Dependencies: Python3, Jinja2, xopp2py
#### Entry point: xopp2oml.convert
Python script that takes as input as .xopp file and produces as output an .oml file.
## Running the tests
The tests are not included in the packages themselves, but as a separate script.
To run the tests, make sure the packages are installed, and run:
```
python test/run_tests.py
```