Skip to content

Development Guide

This guide is for developers looking to contribute to or extend evid, a tool for managing PDF documents with metadata and labels.

Project Structure

evid/
├── src/
│   ├── evid/
│   │   ├── core/           # Core functionality (database, date extraction, LaTeX)
│   │   ├── gui/            # PyQt6 GUI components
│   │   └── __init__.py     # Package metadata
├── tests/                  # Unit tests
├── docs/                   # MkDocs documentation
├── .github/workflows/      # CI pipeline
├── pyproject.toml          # Poetry configuration
├── README.md               # Project overview
└── mkdocs.yml              # MkDocs configuration

Setting Up for Development

  1. Clone and Install:
git clone <repository-url>
cd evid
poetry install --with dev

The --with dev flag includes testing dependencies like pytest and pytest-qt.

  1. Run Tests:
poetry run pytest

Tests cover date extraction, GUI components, LaTeX generation, and database functionality.

Contributing

  1. Fork and Branch:

  2. Fork the repository and create a feature branch: git checkout -b feature/your-feature.

  3. Code Style:

  4. Follow PEP 8 for Python code.
  5. Use type hints where applicable (see src/evid/core/ for examples).

  6. Add docstrings for public functions and classes.

  7. Add Tests:

  8. Add unit tests in the tests/ directory for new functionality.

  9. Use pytest fixtures for setup (e.g., temp_pdf in test_dateextract.py).

  10. Update Documentation:

  11. Modify docs/ files for new features or changes.

  12. Preview documentation locally:

    poetry run mkdocs serve

  13. Submit a Pull Request:

  14. Push your branch and create a PR against the main branch.
  15. Ensure the CI pipeline passes (runs pytest on Ubuntu with Python 3.9).

Extending evid

  • New GUI Tabs: Add new classes in src/evid/gui/tabs/ and register them in src/evid/gui/main.py.
  • Custom Metadata: Extend info.yml fields in src/evid/gui/tabs/add_evidence.py.
  • LaTeX Templates: Modify templates in src/evid/core/label_setup.py or src/evid/core/rebut_doc.py.

For issues or feature requests, check the repository's issue tracker.