Gitmind

AI powered Git repository analysis and reporting.

This project is currently in its infancy. The readme will be updated to include more information as the project progresses.

If you find what you are seeing intriguing, go ahead and ⭐️ the repository to show your support.

Local Development

Prerequisites

• A compatible python version. It's recommended to use pyenv to manage
  python versions.
• pdm installed.
• pre-commit installed.
• hatch installed,

Setup

1. Clone the repository
2. Inside the repository, install the dependencies with:

      pdm install
   

   This will create a virtual env under the git ignored .venv folder and install all the dependencies.
3. Install the pre-commit hooks:

      pre-commit install && pre-commit install --hook-type commit-msg
   

   This will install the pre-commit hooks that will run before every commit. This includes linters and formatters.

Linting

To lint the codebase, run:

   pdm run lint

Tip: You can also run the linters configured in pyproject.toml inside your IDE of choice.

Testing

To run the tests, run:

   pdm run test

Tox

To run the tests with tox, run:

   pdm run tox