{"id":16393627,"url":"https://github.com/code-yeongyu/python-poetry-template","last_synced_at":"2025-02-23T02:21:34.214Z","repository":{"id":112057156,"uuid":"582876463","full_name":"code-yeongyu/Python-Poetry-Template","owner":"code-yeongyu","description":"All-configured python project template","archived":false,"fork":false,"pushed_at":"2023-04-15T07:34:42.000Z","size":57,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-04T04:14:02.503Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/code-yeongyu.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}},"created_at":"2022-12-28T05:35:53.000Z","updated_at":"2023-04-16T08:01:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"50408f31-8bf0-4107-aed1-4e20a6bf6a3e","html_url":"https://github.com/code-yeongyu/Python-Poetry-Template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-yeongyu%2FPython-Poetry-Template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-yeongyu%2FPython-Poetry-Template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-yeongyu%2FPython-Poetry-Template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-yeongyu%2FPython-Poetry-Template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/code-yeongyu","download_url":"https://codeload.github.com/code-yeongyu/Python-Poetry-Template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240258775,"owners_count":19773056,"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":[],"created_at":"2024-10-11T04:53:50.871Z","updated_at":"2025-02-23T02:21:34.169Z","avatar_url":"https://github.com/code-yeongyu.png","language":"Python","readme":"# Python Poetry Template\n\nThis template is designed to make it easy to set up a Python project that is well-structured, organized, and easy to maintain. It comes pre-configured with several tools that will help you develop your project more efficiently, including:\n\n- Visual Studio Code integration: with the `RunOnSave`, `even-better-toml` and `ruff` extensions installed, you can format, lint, and type-check your code automatically every time you save a file.\n- Type checking: this template is configured to use `mypy` and `pyright` to automatically infer types when possible, without imposing strict typing requirements on your code.\n- Linting: `ruff`, an extremely fast Python linter, written in Rust is configured well to help you catch and fix code style issues.\n- Formatting: `yapf`, `ruff`, and `unify` are configured to help you keep your code clean and well-organized.\n- Testing: `pytest` is configured to make it easy to run tests, and `pytest-cov` is configured to help you measure code coverage.\n- Dependency management: `poetry` is configured to help you manage your project's dependencies.\n- Toolkits: `invoke` is configured to provide a range of useful tasks, such as running your code, running tests, formatting your code, and checking your code style and types. These tasks are fully configurable in the [tasks.py](tasks.py) file.\n\n## Installation\n\nTo install this template, simply follow these steps:\n\n```sh\ngit clone git@github.com:code-yeongyu/Python-Poetry-Template.git\ncd Python-Poetry-Template\npoetry install\ncode --install-extension emeraldwalk.RunOnSave\ncode --install-extension tamasfe.even-better-toml\ncode --install-extension charliermarsh.ruff\n```\n\n## Usage\n\nTo use this template, you can follow these steps:\n\n### Open Shell\n\nTo open a shell in the project directory, use the following command:\n\n```sh\npoetry shell\n```\n\n### Name your project\n\n```sh\ninvoke rename-project \u003cyour-project-name\u003e\n```\n\n### Run Code\n\nTo run your code, use the following command:\n\n```sh\npoetry run invoke run\n```\n\n### Run Tests\n\nTo run your tests, use the following command:\n\n```sh\npoetry run invoke test\n```\n\n### Run Formatters\n\nTo run the code formatters, use the following command:\n\n```sh\npoetry run invoke format_code\n```\n\n### Run Checking Code Style \u0026 Type hint\n\nTo check your code style and type hints, use the following command:\n\n```sh\npoetry run invoke check\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-yeongyu%2Fpython-poetry-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcode-yeongyu%2Fpython-poetry-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-yeongyu%2Fpython-poetry-template/lists"}