Contributing

Development Status

PDFSyntax is currently MIT licensed, but the author notes it is "Open-Source, not Open-Contribution yet" while core features are stabilized. However, you can still fork the project and run it locally for development.

Setting up a Development Environment

  1. Clone the repo:

    git clone https://github.com/desgeeko/pdfsyntax.git

  2. Run Tests: The project uses Python's unittest. You can run the suite via the makefile:

    make test
    Or manually:
    python3 -m unittest discover ./tests -v

  3. Clean Build Artifacts:

    make clean

  4. Build Package:

    make build