{"id":13595608,"url":"https://github.com/k2bd/action-python-poetry","last_synced_at":"2025-12-30T00:59:39.323Z","repository":{"id":106375567,"uuid":"434894145","full_name":"k2bd/action-python-poetry","owner":"k2bd","description":"Template repo to quickly make a tested and documented GitHub action in Python with Poetry","archived":false,"fork":false,"pushed_at":"2024-03-20T16:02:53.000Z","size":22,"stargazers_count":91,"open_issues_count":1,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-01T16:41:40.021Z","etag":null,"topics":["actions","github-actions","poetry","poetry-python","python","python3","template","templates"],"latest_commit_sha":null,"homepage":"","language":"Python","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/k2bd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","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},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"k2bddev","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2021-12-04T12:23:44.000Z","updated_at":"2024-04-17T15:11:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"a3a672b2-3094-4c5b-bd2f-b5c92c2ade6b","html_url":"https://github.com/k2bd/action-python-poetry","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/k2bd%2Faction-python-poetry","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/k2bd%2Faction-python-poetry/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/k2bd%2Faction-python-poetry/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/k2bd%2Faction-python-poetry/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/k2bd","download_url":"https://codeload.github.com/k2bd/action-python-poetry/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223394638,"owners_count":17138590,"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":["actions","github-actions","poetry","poetry-python","python","python3","template","templates"],"created_at":"2024-08-01T16:01:53.510Z","updated_at":"2025-12-30T00:59:39.281Z","avatar_url":"https://github.com/k2bd.png","language":"Python","readme":"# Python + Poetry GitHub Action Template\n\n## Getting started from the template\n1. Rename the `src/action_python_poetry` package.\n1. Globally replace instances of `action-python-poetry` and `action_python_poetry` with your project and package name.\n1. If your repo is private, set it up on [CodeCov](https://app.codecov.io/) and add a codecov token to your repo under the `CODECOV_TOKEN` secret.\n1. Create and test your action. `__main__.py` in your package will be executed when the action is run. The environment variables your tests use can be [set in `pyproject.toml`](https://github.com/k2bd/action-python-poetry/blob/694756b8ff6656f8e1a9a4a141f293100f55229d/pyproject.toml#L39-L41) and/or managed in test fixtures.\n1. Update `action.yml`, `README.md`, and `.github/workflows/test-action.yml` to reflect your action's specification.\n1. Update `LICENSE.md` as appropriate, making sure to retain the original copyright and permissions notices in your distribution according to the MIT license that this template is distributed under.\n1. Remove this section from `README.md`.\n1. Happy hacking!\n\n### Like this template?\n[![\"Buy Me A Coffee\"](https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png)](https://www.buymeacoffee.com/k2bd)\n\n## Quickstart\n\n```yml\nname: Run Action\non:\n  workflow_dispatch:\n\njobs:\n  action-python-poetry:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: k2bd/action-python-poetry@v1\n        with:\n          helloName: k2bd\n          repeats: 3\n```\n\n## Action Specification\n\n### `helloName`\n\n**Required**\n\nThe name of the person to say hello to\n\n### `repeats`\n\n*Optional* - default 1\n\nNumber of times to say hello to this person\n\n## Developing\n\nInstall [Poetry](https://python-poetry.org/) and `poetry install` the project\n\n### Useful Commands\n\nNote: if Poetry is managing a virtual environment for you, you may need to use `poetry run poe` instead of `poe`\n\n- `poe autoformat` - Autoformat code\n- `poe lint` - Linting\n- `poe test` - Run Tests\n\n### Testing the action\n\nThe action can be tested locally by building the Dockerfile, e.g.\n\n```sh\ndocker run -e INPUT_HELLONAME=k2bd -e INPUT_REPEATS=2 $(docker build -q .)\n```\n\nAdditionally, there is a manual invocation action on the repo called \"Test Action\" that can be used to invoke the repo's version of the action from the Actions tab of the repo.\n\n### Releasing\n\nRelease a new version by creating a new annotated semver tag e.g. `git tag -a v1.2.3 -m \"Release version 1.2.3\"` and pushing it (`git push --tags`). Then create a new release from that tag in GitHub.\n\nThere is an autoversioning action that keeps major version tags (`v1`, `v2`, ...) and `latest` up-to-date when a new release is published.\n","funding_links":["https://ko-fi.com/k2bddev","https://www.buymeacoffee.com/k2bd"],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fk2bd%2Faction-python-poetry","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fk2bd%2Faction-python-poetry","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fk2bd%2Faction-python-poetry/lists"}