<p align="center">
<!-- github-banner-start -->
<img src="https://github.com/Goldziher/gitmind/blob/main/assets/logo_white_bg.svg?raw=true" alt="GitMind Logo - Light" width="100%" height="auto" />
<!-- github-banner-end -->
</p>
# 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
```
### Testing
To run the tests, run:
```shell
pdm run test
```
Tip: You can also run the linters configured in `pyproject.toml` inside your IDE of choice.
Raw data
{
"_id": null,
"home_page": null,
"name": "gitmind",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ai, analysis, dev-tools, git, linting, reporting, repository",
"author": null,
"author_email": "Na'aman Hirschfeld <nhirschfeld@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/26/e4/c5dcb7ba82b345034b7ede39f789ca3500407ece4989ca7c96b0ef51a99c/gitmind-0.0.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <!-- github-banner-start -->\n <img src=\"https://github.com/Goldziher/gitmind/blob/main/assets/logo_white_bg.svg?raw=true\" alt=\"GitMind Logo - Light\" width=\"100%\" height=\"auto\" />\n <!-- github-banner-end -->\n</p>\n\n# Gitmind\n\nAI powered Git repository analysis and reporting.\n\nThis project is currently in its infancy. The readme will be updated to include more information as the project progresses.\n\nIf you find what you are seeing intriguing, go ahead and \u2b50\ufe0f the repository to show your support.\n\n## Local Development\n\n### Prerequisites\n\n- A compatible python version. It's recommended to use [pyenv](https://github.com/pyenv/pyenv) to manage\npython versions.\n- [pdm](https://github.com/pdm-project/pdm) installed.\n- [pre-commit](https://pre-commit.com) installed.\n- [hatch](https://hatch.pypa.io) installed,\n\n### Setup\n\n1. Clone the repository\n3. Inside the repository, install the dependencies with:\n ```shell\n pdm install\n ```\n This will create a virtual env under the git ignored `.venv` folder and install all the dependencies.\n3. Install the pre-commit hooks:\n ```shell\n pre-commit install && pre-commit install --hook-type commit-msg\n ```\n This will install the pre-commit hooks that will run before every commit. This includes linters and formatters.\n\n### Linting\n\nTo lint the codebase, run:\n```shell\n pdm run lint\n```\n\n### Testing\n\nTo run the tests, run:\n```shell\n pdm run test\n```\n\nTip: You can also run the linters configured in `pyproject.toml` inside your IDE of choice.\n",
"bugtrack_url": null,
"license": "BUSL-1.1",
"summary": "AI powered Git repository analysis and reporting",
"version": "0.0.1",
"project_urls": {
"Repository": "https://github.com/Goldziher/gitmind"
},
"split_keywords": [
"ai",
" analysis",
" dev-tools",
" git",
" linting",
" reporting",
" repository"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26e4c5dcb7ba82b345034b7ede39f789ca3500407ece4989ca7c96b0ef51a99c",
"md5": "5fa738074a35ca33aecafa53c664af2e",
"sha256": "5f56025f35b19bdadf488bc7f7a687f47f476c1044e97e2e886dc1fcdc9e1188"
},
"downloads": -1,
"filename": "gitmind-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5fa738074a35ca33aecafa53c664af2e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 19394,
"upload_time": "2024-07-16T19:58:30",
"upload_time_iso_8601": "2024-07-16T19:58:30.007613Z",
"url": "https://files.pythonhosted.org/packages/26/e4/c5dcb7ba82b345034b7ede39f789ca3500407ece4989ca7c96b0ef51a99c/gitmind-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-16 19:58:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Goldziher",
"github_project": "gitmind",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gitmind"
}
JSON
