cookiecutter-rag


Namecookiecutter-rag JSON
Version 0.0.3 PyPI version JSON
download
home_pagehttps://github.com/DeepakPant93/cookiecutter-rag
SummaryA python cookiecutter application to create a new python project for GenAI RAG application that uses poetry to manage its dependencies.
upload_time2024-12-20 10:12:26
maintainerNone
docs_urlNone
authorDeepak Pant
requires_python<4.0,>=3.8
licenseMIT
keywords cookiecutter template poetry
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Cookiecutter General AI RAG Application Development Template

This is a modern **Cookiecutter** template for initializing Python projects, particularly for **General AI RAG Application Development**. It provides a comprehensive setup for development, testing, and deployment, incorporating essential tools for effective project management.

## Features

This template includes the following features:

-   **[Poetry](https://python-poetry.org/)** for dependency management
-   **CI/CD** with **[GitHub Actions](https://github.com/features/actions)**
-   **Pre-commit hooks** using **[pre-commit](https://pre-commit.com/)**
-   **Code quality checks** with **[ruff](https://github.com/charliermarsh/ruff)**, **[mypy](https://mypy.readthedocs.io/en/stable/)**, **[deptry](https://github.com/fpgmaas/deptry/)**, and **[prettier](https://prettier.io/)**
-   **Publishing to [PyPI](https://pypi.org)** via GitHub releases
-   **Testing and coverage** with **[pytest](https://docs.pytest.org/en/7.1.x/)** and **[codecov](https://about.codecov.io/)**
-   **Documentation generation** with **[MkDocs](https://www.mkdocs.org/)**
-   **Python compatibility testing** with **[Tox](https://tox.wiki/en/latest/)**
-   **Containerization** using **[Docker](https://www.docker.com/)**
-   **Development environment** with **[VSCode devcontainers](https://code.visualstudio.com/docs/devcontainers/containers)**
-   **Deployment** with **[Azure Container Apps](https://azure.microsoft.com/en-in/products/container-apps)**

You can find an example repository created using this template [here](https://github.com/DeepakPant93/cookiecutter-rag).

## Quickstart

To get started, follow these steps:

### Step 1: Install `cookiecutter-rag`

First, navigate to the directory where you want to create the project and run:

```bash
pip install cookiecutter-rag
```

Alternatively, you can install **cookiecutter** and use the GitHub repository URL directly:

```bash
pip install cookiecutter
cookiecutter git@github.com:DeepakPant93/cookiecutter-rag.git
```

### Step 2: Create a GitHub Repository

Create a new repository on GitHub, then run the following commands in your terminal, replacing `<project-name>` with your GitHub repository name and `<github_author_handle>` with your GitHub username:

```bash
cd <project_name>
make init-repo
```

### Step 3: Install the Environment and Pre-commit Hooks

Run the following command to install the environment and pre-commit hooks:

```bash
make bake-env
```

Now you're all set to start development! The CI/CD pipeline will automatically trigger on pull requests, merges to the main branch, and new releases.

For instructions on publishing to **PyPI**, refer to [this guide](./features/publishing.md#set-up-for-pypi). To enable automatic documentation with **MkDocs**, follow the steps in [this guide](./features/mkdocs.md). For code coverage setup, refer to [this guide](./features/codecov.md).

## Documentation

You can find the documentation for this template [here](https://DeepakPant93.github.io/cookiecutter-rag/).

## Acknowledgements

This project is inspired by **[Audrey Feldroy's](https://github.com/audreyfeldroy)** excellent work on the [cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) template.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/DeepakPant93/cookiecutter-rag",
    "name": "cookiecutter-rag",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "cookiecutter, template, poetry",
    "author": "Deepak Pant",
    "author_email": "DeepakPant93@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/9a/7f/f9e5c195c188545d1e27718b232c6b63622b62a663f3074222f18b26825e/cookiecutter_rag-0.0.3.tar.gz",
    "platform": null,
    "description": "# Cookiecutter General AI RAG Application Development Template\n\nThis is a modern **Cookiecutter** template for initializing Python projects, particularly for **General AI RAG Application Development**. It provides a comprehensive setup for development, testing, and deployment, incorporating essential tools for effective project management.\n\n## Features\n\nThis template includes the following features:\n\n-   **[Poetry](https://python-poetry.org/)** for dependency management\n-   **CI/CD** with **[GitHub Actions](https://github.com/features/actions)**\n-   **Pre-commit hooks** using **[pre-commit](https://pre-commit.com/)**\n-   **Code quality checks** with **[ruff](https://github.com/charliermarsh/ruff)**, **[mypy](https://mypy.readthedocs.io/en/stable/)**, **[deptry](https://github.com/fpgmaas/deptry/)**, and **[prettier](https://prettier.io/)**\n-   **Publishing to [PyPI](https://pypi.org)** via GitHub releases\n-   **Testing and coverage** with **[pytest](https://docs.pytest.org/en/7.1.x/)** and **[codecov](https://about.codecov.io/)**\n-   **Documentation generation** with **[MkDocs](https://www.mkdocs.org/)**\n-   **Python compatibility testing** with **[Tox](https://tox.wiki/en/latest/)**\n-   **Containerization** using **[Docker](https://www.docker.com/)**\n-   **Development environment** with **[VSCode devcontainers](https://code.visualstudio.com/docs/devcontainers/containers)**\n-   **Deployment** with **[Azure Container Apps](https://azure.microsoft.com/en-in/products/container-apps)**\n\nYou can find an example repository created using this template [here](https://github.com/DeepakPant93/cookiecutter-rag).\n\n## Quickstart\n\nTo get started, follow these steps:\n\n### Step 1: Install `cookiecutter-rag`\n\nFirst, navigate to the directory where you want to create the project and run:\n\n```bash\npip install cookiecutter-rag\n```\n\nAlternatively, you can install **cookiecutter** and use the GitHub repository URL directly:\n\n```bash\npip install cookiecutter\ncookiecutter git@github.com:DeepakPant93/cookiecutter-rag.git\n```\n\n### Step 2: Create a GitHub Repository\n\nCreate a new repository on GitHub, then run the following commands in your terminal, replacing `<project-name>` with your GitHub repository name and `<github_author_handle>` with your GitHub username:\n\n```bash\ncd <project_name>\nmake init-repo\n```\n\n### Step 3: Install the Environment and Pre-commit Hooks\n\nRun the following command to install the environment and pre-commit hooks:\n\n```bash\nmake bake-env\n```\n\nNow you're all set to start development! The CI/CD pipeline will automatically trigger on pull requests, merges to the main branch, and new releases.\n\nFor instructions on publishing to **PyPI**, refer to [this guide](./features/publishing.md#set-up-for-pypi). To enable automatic documentation with **MkDocs**, follow the steps in [this guide](./features/mkdocs.md). For code coverage setup, refer to [this guide](./features/codecov.md).\n\n## Documentation\n\nYou can find the documentation for this template [here](https://DeepakPant93.github.io/cookiecutter-rag/).\n\n## Acknowledgements\n\nThis project is inspired by **[Audrey Feldroy's](https://github.com/audreyfeldroy)** excellent work on the [cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) template.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A python cookiecutter application to create a new python project for GenAI RAG application that uses poetry to manage its dependencies.",
    "version": "0.0.3",
    "project_urls": {
        "Documentation": "https://DeepakPant93.github.io/cookiecutter-rag/",
        "Homepage": "https://github.com/DeepakPant93/cookiecutter-rag",
        "Repository": "https://github.com/DeepakPant93/cookiecutter-rag"
    },
    "split_keywords": [
        "cookiecutter",
        " template",
        " poetry"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d836c4c0719be4150a5c897bd397e55b7a762fbde41fad154a613e663c0c8182",
                "md5": "d35c479833f2eac9ae42c20546609581",
                "sha256": "068171e738ead97af020a8a5ff5a44d3224024e7fee13513b7084974cfac025e"
            },
            "downloads": -1,
            "filename": "cookiecutter_rag-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d35c479833f2eac9ae42c20546609581",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 123037,
            "upload_time": "2024-12-20T10:12:24",
            "upload_time_iso_8601": "2024-12-20T10:12:24.163098Z",
            "url": "https://files.pythonhosted.org/packages/d8/36/c4c0719be4150a5c897bd397e55b7a762fbde41fad154a613e663c0c8182/cookiecutter_rag-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9a7ff9e5c195c188545d1e27718b232c6b63622b62a663f3074222f18b26825e",
                "md5": "a7312d4260d0b32fd84581da8240a7c9",
                "sha256": "a64c2cb905333eec569570b53628474680a2337fae7c904483241aee45218856"
            },
            "downloads": -1,
            "filename": "cookiecutter_rag-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "a7312d4260d0b32fd84581da8240a7c9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 108777,
            "upload_time": "2024-12-20T10:12:26",
            "upload_time_iso_8601": "2024-12-20T10:12:26.760148Z",
            "url": "https://files.pythonhosted.org/packages/9a/7f/f9e5c195c188545d1e27718b232c6b63622b62a663f3074222f18b26825e/cookiecutter_rag-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-20 10:12:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "DeepakPant93",
    "github_project": "cookiecutter-rag",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "cookiecutter-rag"
}
        
Elapsed time: 0.38771s