Documentation for setting up and contributing to the Chorderizer codebase.

1. Prerequisites:

   • Python 3.8+
   • Pip (Python Package Index)

2. Clone and Install:

   git clone https://github.com/julesklord/Chorderizer.git
   cd Chorderizer
   pip install -e .

3. Running in Development Mode: To run the project while making changes without reinstalling:

   $env:PYTHONPATH="src"
   py -m chorderizer.chorderizer

Chorderizer uses pytest for automated testing.

• Running all tests:

  pytest

• Test Categories:

  • tests/test_theory.py: Music theory math and parsing.
  • tests/test_generators.py: Chord and MIDI logic (uses mocks).
  • tests/test_security.py: Path sanitization and security checks.

We use Ruff for linting and formatting to ensure a high-quality codebase.

• Check for issues:

  ruff check src/ tests/

• Format code:

  ruff format src/ tests/

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'feat: add amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.