{"id":15882745,"url":"https://github.com/chris-santiago/cookie","last_synced_at":"2026-02-28T05:18:34.017Z","repository":{"id":64912548,"uuid":"402113006","full_name":"chris-santiago/cookie","owner":"chris-santiago","description":"Cookiecutter template","archived":false,"fork":false,"pushed_at":"2024-08-27T03:10:25.000Z","size":70,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-21T19:53:31.309Z","etag":null,"topics":["black","cookiecutter","nox","pdm","pyright","pytest","python","ruff"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chris-santiago.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-09-01T15:34:57.000Z","updated_at":"2024-08-27T03:10:29.000Z","dependencies_parsed_at":"2024-08-27T04:03:55.961Z","dependency_job_id":"d368a1f4-c8f3-4d60-b77b-0444063e0bca","html_url":"https://github.com/chris-santiago/cookie","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/chris-santiago/cookie","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-santiago%2Fcookie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-santiago%2Fcookie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-santiago%2Fcookie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-santiago%2Fcookie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chris-santiago","download_url":"https://codeload.github.com/chris-santiago/cookie/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-santiago%2Fcookie/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29925683,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T19:37:42.220Z","status":"online","status_checked_at":"2026-02-28T02:00:07.010Z","response_time":90,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["black","cookiecutter","nox","pdm","pyright","pytest","python","ruff"],"created_at":"2024-10-06T04:06:58.698Z","updated_at":"2026-02-28T05:18:33.972Z","avatar_url":"https://github.com/chris-santiago.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cookiecutter Template\n\n[Cookiecutter](https://cookiecutter.readthedocs.io/en/stable/README.html) is command-line utility \nthat creates projects from cookiecutters (project templates), e.g. creating a Python package project \nfrom a Python package project template.\n\n- Documentation: [https://cookiecutter.readthedocs.io](https://cookiecutter.readthedocs.io)\n- GitHub: [https://github.com/cookiecutter/cookiecutter](https://github.com/cookiecutter/cookiecutter)\n\n## PDM \n\nThis cookie assumes that you've installed PDM via these [instructions](https://pdm.fming.dev/latest/#update-the-pdm-version)\n\nThe `post_gen_project.sh` hook can be modified to install PDM in virtual environment via pip, if\ndesired (though not recommended).\n\n## Included Tools\n\n| Function                         | Tool                | Link                                         |\n|----------------------------------|---------------------|----------------------------------------------|\n| Dependency management            | PDM                 | https://pdm.fming.dev/latest/                |\n| Documentation                    | MkDocs              | https://www.mkdocs.org/                      |\n| Documentation: theme             | Material for MkDocs | https://squidfunk.github.io/mkdocs-material/ |\n| Documentation: auto docstrings   | mkdocstrings-python | https://mkdocstrings.github.io/python/       |\n| Automated testing                | Nox                 | https://nox.thea.codes/en/stable/index.html  |\n| Testing                          | pytest              | https://docs.pytest.org/en/7.3.x/            |\n| Linting                          | ruff                | https://docs.astral.sh/ruff/                 |\n| Type checking                    | Pyright             | https://microsoft.github.io/pyright/#/       |\n| Formatting                       | ruff                | https://docs.astral.sh/ruff/                 |\n| Automated QA                     | pre-commit          | https://pre-commit.com/                      |\n| QA                               | isort               | https://pycqa.github.io/isort/               |\n| QA                               | check-manifest      | https://github.com/mgedmin/check-manifest    |\n| Linting                          | SQLFluff            | https://www.sqlfluff.com/                    |\n| Documentation: Build and publish | GitHub Actions      | https://docs.github.com/en/actions           |\n| PyPI: Publish                    | GitHub Actions      | https://docs.github.com/en/actions           |\n\n## Getting Started\n\nUsing a Python environment with `cookiecutter` installed, run:\n\n`cookiecutter https://github.cloud.capitalone.com/lno127/cookie.git`\n\nand complete the prompts.\n\n```bash\ncd \u003cyour project dir\u003e\nconda env create -f environment.yml\nconda activate \u003cyour env name\u003e\npdm install\ngit init\npre-commit install\n```\n\n~~This cookie executes a post-generation script (`hooks/post_gen_project.sh`) that will:~~\n\n~~1. Create a virtual environment via Conda\n2. Install all development dependencies in your virtual environment\n3. Install your project (editable) in your virtual environment\n4. Initialize a git repo in your new project directory\n5. Install pre-commit in your repo~~\n\n## PDM Quickstart\n\nAs installed via this cookie, PDM will automatically detect the Conda virtual environment and operate\nwithin. See [Working with Virtual Environments](https://pdm.fming.dev/latest/usage/venv/) for other\noptions.\n\nHere are a few commands to get you started. For much more, see the [CLI Reference](https://pdm.fming.dev/latest/reference/cli/)\nor [Manage Dependencies](https://pdm.fming.dev/latest/usage/dependency/) guide.\n\n### Add a required dependency\n\n`pdm add \u003cpackage\u003e`\n\nExample: `pdm add numpy`\n\n\n### Add a development dependency\n\n`pdm add -d \u003cpackage\u003e`\n\nExample: `pdm add -d flake8`\n\n\n### Add a development dependency into a specific group\n\n`pdm add -dG \u003cgroup name\u003e \u003cpackage\u003e`\n\nExample: `pdm add -dG qa flake8`\n\n### List Dependencies\n\n`pdm list`\n\n### List Dependencies as Graph\n\n`pdm list --graph`\n\n### Export Dependencies\n\n`pdm export -o requirements.txt`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchris-santiago%2Fcookie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchris-santiago%2Fcookie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchris-santiago%2Fcookie/lists"}