Skip to main content

Development Guide

Welcome to the VeriSynth Core developer guide.
This document walks you through setting up your local environment, running the CLI, writing tests, and contributing to the project.
VeriSynth Core is fully open source (MIT licensed) and welcomes community contributions.

1. Clone the Repository


2. Create a Virtual Environment

We recommend using Python 3.10+ and a virtual environment for isolation.

3. Install Dependencies

For development (with linting, testing, and docs):

4. Project Structure


5. Run the CLI (Development Mode)

You can run VeriSynth directly from source:
Or after install:

6. Testing

We use pytest as our primary testing framework. Run all tests:
Run a single test file:
To see coverage:

7. Contributing

We welcome pull requests from the community! Basic PR process:
  1. Fork the repository
  2. Create a new branch (feature/add-metrics, fix/cli-output, etc.)
  3. Commit cleanly with clear messages
  4. Run pytest before pushing
  5. Submit your PR and link to any related issue
Example commit:

8. Publishing (for Maintainers)

Tag a release:
Build and upload to PyPI:

9. Development Roadmap


❤️ Community

Join the discussion, report issues, or propose features: