{"id":16949238,"url":"https://github.com/f4str/python-package-template","last_synced_at":"2025-03-21T10:10:56.722Z","repository":{"id":106168513,"uuid":"380409595","full_name":"f4str/python-package-template","owner":"f4str","description":"Template Python package with linting, tests, and CI","archived":false,"fork":false,"pushed_at":"2021-08-26T04:50:56.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-26T06:26:26.303Z","etag":null,"topics":["continous-integration","linting","python","template","tox","worflows"],"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/f4str.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2021-06-26T04:03:50.000Z","updated_at":"2021-12-30T00:01:15.000Z","dependencies_parsed_at":"2023-06-15T21:15:30.659Z","dependency_job_id":null,"html_url":"https://github.com/f4str/python-package-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/f4str%2Fpython-package-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f4str%2Fpython-package-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f4str%2Fpython-package-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f4str%2Fpython-package-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/f4str","download_url":"https://codeload.github.com/f4str/python-package-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244776340,"owners_count":20508506,"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":["continous-integration","linting","python","template","tox","worflows"],"created_at":"2024-10-13T21:53:31.361Z","updated_at":"2025-03-21T10:10:56.698Z","avatar_url":"https://github.com/f4str.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python Package Template\n\nTemplate git repository for creating Python packages. Includes the a sample project structure, linting, type checks, unit tests, formatting, and continuous integration.\n\n## Installation\n\nClone the repository.\n\n```bash\ngit clone https://github.com/f4str/python-package-template\n```\n\nChange directories into the cloned repository.\n\n```bash\ncd python-package-template\n```\n\nInstall Python and create a virtual environment.\n\n```bash\npython3 -m venv venv\nsource venv/bin/activate\n```\n\nInstall the dev dependencies using pip.\n\n```bash\npip install -e .[dev]\n```\n\n## Development\n\nThe `tox` library is used to run all tests and code formatting. This is automatically installed with the dev requirements. The available options are as follows.\n\n* Run linting checks using `flake8`.\n\n    ```bash\n    tox -e lint\n    ```\n\n* Run type checks using `mypy`.\n\n    ```bash\n    tox -e type\n    ```\n\n* Run unit tests `pytest`.\n\n    ```bash\n    tox -e test\n    ```\n\n* Run all three of the tests above.\n\n    ```bash\n    tox\n    ```\n\n* Format the code using `black` and `isort` to comply with linting conventions.\n\n    ```bash\n    tox -e format\n    ```\n\nUpon pull request, merge, or push to the `master` branch, the three tests with `tox` will be run using GitHub Actions. The workflow will fail if any of the tests fail. See `.github/workflows/python-package.yml` for more information on how the CI works.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff4str%2Fpython-package-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ff4str%2Fpython-package-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff4str%2Fpython-package-template/lists"}