Tests
This application should be used as a dependency from other projects. Development has been made using poetry, so you should have it installed.
In case you really do not want to use poetry, you coul run test using pytest
Commands
While using poetry framework you could simply run
poetry run pytest
If you do not want to use poetry you can run
python3 -m pytest
Behaviour
If everything is right you should generate 1 single file syscall.nim
using the default command line:
./main.py
Some samples files are stored in examples-output
so you can compare them with your results.
Documentation
This project use mkdocs associated with lazydocs to auto-generate documentation.
- Write your Doc-String by using AutoDocString in VSCode
- Generate the project documentation using LazyDoc
export PYTHONPATH=$PWD; lazydocs --output-path="./docs/documentation" --overview-file="README.md" --src-base-url="https://github.com/x42en/sysplant/blob/master" sysplant/
- Serving local docs for preview using mkdocs
mkdocs serve