{"id":18037448,"url":"https://github.com/fpgmaas/cookiecutter-uv-example","last_synced_at":"2025-03-27T09:31:33.375Z","repository":{"id":255892626,"uuid":"851519422","full_name":"fpgmaas/cookiecutter-uv-example","owner":"fpgmaas","description":"An example of a project generated with cookiecutter-uv","archived":false,"fork":false,"pushed_at":"2024-09-10T07:50:03.000Z","size":755,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-10T10:05:15.038Z","etag":null,"topics":["python","uv"],"latest_commit_sha":null,"homepage":"https://github.com/fpgmaas/cookiecutter-uv","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fpgmaas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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}},"created_at":"2024-09-03T08:44:24.000Z","updated_at":"2024-09-10T07:50:06.000Z","dependencies_parsed_at":"2024-09-10T09:52:25.055Z","dependency_job_id":null,"html_url":"https://github.com/fpgmaas/cookiecutter-uv-example","commit_stats":null,"previous_names":["fpgmaas/cookiecutter-uv-example"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpgmaas%2Fcookiecutter-uv-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpgmaas%2Fcookiecutter-uv-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpgmaas%2Fcookiecutter-uv-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpgmaas%2Fcookiecutter-uv-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fpgmaas","download_url":"https://codeload.github.com/fpgmaas/cookiecutter-uv-example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222226132,"owners_count":16951818,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["python","uv"],"created_at":"2024-10-30T13:10:22.662Z","updated_at":"2024-10-30T13:10:23.295Z","avatar_url":"https://github.com/fpgmaas.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cookiecutter-uv-example\n\n[![Release](https://img.shields.io/github/v/release/fpgmaas/cookiecutter-uv-example)](https://img.shields.io/github/v/release/fpgmaas/cookiecutter-uv-example)\n[![Build status](https://img.shields.io/github/actions/workflow/status/fpgmaas/cookiecutter-uv-example/main.yml?branch=main)](https://github.com/fpgmaas/cookiecutter-uv-example/actions/workflows/main.yml?query=branch%3Amain)\n[![codecov](https://codecov.io/gh/fpgmaas/cookiecutter-uv-example/branch/main/graph/badge.svg)](https://codecov.io/gh/fpgmaas/cookiecutter-uv-example)\n[![Commit activity](https://img.shields.io/github/commit-activity/m/fpgmaas/cookiecutter-uv-example)](https://img.shields.io/github/commit-activity/m/fpgmaas/cookiecutter-uv-example)\n[![License](https://img.shields.io/github/license/fpgmaas/cookiecutter-uv-example)](https://img.shields.io/github/license/fpgmaas/cookiecutter-uv-example)\n\nThis is a template repository for Python projects that use uv for their dependency management.\n\n- **Github repository**: \u003chttps://github.com/fpgmaas/cookiecutter-uv-example/\u003e\n- **Documentation** \u003chttps://fpgmaas.github.io/cookiecutter-uv-example/\u003e\n\n## Getting started with your project\n\n### 1. Create a New Repository\n\nFirst, create a repository on GitHub with the same name as this project, and then run the following commands:\n\n```bash\ngit init -b main\ngit add .\ngit commit -m \"init commit\"\ngit remote add origin git@github.com:fpgmaas/cookiecutter-uv-example.git\ngit push -u origin main\n```\n\n### 2. Set Up Your Development Environment\n\nThen, install the environment and the pre-commit hooks with\n\n```bash\nmake install\n```\n\nThis will also generate your `uv.lock` file\n\n### 3. Run the pre-commit hooks\n\nInitially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:\n\n```bash\nuv run pre-commit run -a\n```\n\n### 4. Commit the changes\n\nLastly, commit the changes made by the two steps above to your repository.\n\n```bash\ngit add .\ngit commit -m 'Fix formatting issues'\ngit push origin main\n```\n\nYou are now ready to start development on your project!\nThe CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.\n\nTo finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).\nFor activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).\nTo enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).\n\n## Releasing a new version\n\n- Create an API Token on [PyPI](https://pypi.org/).\n- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/fpgmaas/cookiecutter-uv-example/settings/secrets/actions/new).\n- Create a [new release](https://github.com/fpgmaas/cookiecutter-uv-example/releases/new) on Github.\n- Create a new tag in the form `*.*.*`.\n\nFor more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).\n\n---\n\nRepository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffpgmaas%2Fcookiecutter-uv-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffpgmaas%2Fcookiecutter-uv-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffpgmaas%2Fcookiecutter-uv-example/lists"}