https://github.com/goldziher/gitmind

AI powered Git repository analysis and reporting
https://github.com/goldziher/gitmind

anthropic git git-analytics gitops groq llms openai python

Last synced: about 2 months ago
JSON representation

AI powered Git repository analysis and reporting

• Host: GitHub
• URL: https://github.com/goldziher/gitmind
• Owner: Goldziher
• License: other
• Created: 2024-06-01T11:56:53.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-07-18T09:10:32.000Z (5 months ago)
• Last Synced: 2024-10-10T23:26:21.008Z (2 months ago)
• Topics: anthropic, git, git-analytics, gitops, groq, llms, openai, python
• Language: Python
• Homepage:
• Size: 287 KB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  

  



# 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](https://github.com/pyenv/pyenv) to manage

  python versions.

- [pdm](https://github.com/pdm-project/pdm) installed.

- [pre-commit](https://pre-commit.com) installed.

- [hatch](https://hatch.pypa.io) installed,

### Setup

1. Clone the repository

3. Inside the repository, install the dependencies with:

   ```shell

      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:

   ```shell

      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:

```shell

   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:

```shell

   pdm run test

```

#### Tox

To run the tests with `tox`, run:

```shell

   pdm run tox

```