Update project layout

This commit is contained in:
Joeri Exelmans 2023-03-03 18:06:13 +01:00
parent ea70d9278e
commit b777df7874
15 changed files with 127 additions and 107 deletions

View file

@ -1,5 +1,33 @@
# xopp2py
# Python interface to Xournal++ (.xopp) file format
Python interface to .xopp (Xournal++) files.
## Packages
The only dependency is Python 3. (developed with Python 3.10)
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
```