{"id":21841111,"url":"https://github.com/skevo18/python-project-template","last_synced_at":"2026-05-06T21:37:19.961Z","repository":{"id":62219574,"uuid":"440211446","full_name":"SKevo18/python-project-template","owner":"SKevo18","description":"A template for new Python projects. Ready for pytest for tests, pdoc for automatic documentation from docstrings, setup.py and automatic tests on every push, automatic PyPI package publishing \u0026 documentation building via GH Pages on new releases.","archived":false,"fork":false,"pushed_at":"2022-10-28T15:56:27.000Z","size":86,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-26T11:11:16.371Z","etag":null,"topics":["project","python","template"],"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/SKevo18.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}},"created_at":"2021-12-20T15:06:47.000Z","updated_at":"2023-03-05T13:22:38.000Z","dependencies_parsed_at":"2022-10-28T17:00:49.247Z","dependency_job_id":null,"html_url":"https://github.com/SKevo18/python-project-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/SKevo18%2Fpython-project-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SKevo18%2Fpython-project-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SKevo18%2Fpython-project-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SKevo18%2Fpython-project-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SKevo18","download_url":"https://codeload.github.com/SKevo18/python-project-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244823902,"owners_count":20516371,"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":["project","python","template"],"created_at":"2024-11-27T21:29:07.323Z","updated_at":"2026-05-06T21:37:19.934Z","avatar_url":"https://github.com/SKevo18.png","language":"Python","funding_links":["https://www.buymeacoffee.com/skevo","https://img.buymeacoffee.com/button-api/?text=Support"],"categories":[],"sub_categories":[],"readme":"# Python project template\n\nA template for new Python projects.\n\n## Features\n\n- Automatically builds [PDoc](https://pdoc3.github.io/pdoc/) documentation \u0026 uploads package to [PyPI](https://pypi.org) on new GitHub release, thanks to GitHub actions;\n- Tests with pyTest before uploading to PyPI (or you can test manually with `workflow-dispatch`);\n- Ready-to-go `setup.py` file;\n- Scripts to build documentation and compile as a Python package;\n- A to-do list below;\n- Possibly more ;)\n\n## Your to-do list\n\n- [ ] Edit `# FIXME` lines to match your project;\n  - [ ] setup.py\n    - [ ] Package name\n    - [ ] License\n    - [ ] Version\n    - [ ] Author\n    - [ ] Author email\n    - [ ] Description\n    - [ ] Keywords\n    - [ ] Classifiers\n    - [ ] Repository URL\n- [ ] Setup virtualenv (`scripts/setup_virtualenv_windows.ps1` for Windows);\n- [ ] Rename `python_project_template` folder and start writing your source code;\n- [ ] Add your dependencies to `requirements.txt`;\n- [ ] Update .gitingore with your stuff;\n- [ ] Replace this `README.md` file with a fancier one;\n- [ ] Upload code to your GitHub repository;\n- [ ] Turn on GitHub pages and use `documentation` as your pages branch;\n- [ ] Add your editior to `.gitignore`;\n- [ ] Add your PyPI API key to GitHub secrets (`PYPI_API_TOKEN`);\n- [ ] When your are done, make a new release at GitHub to build documentation and upload to PyPI;\n  - Don't forget to bump version in `setup.py` everytime you do a new release!!!\n\nGenerated documentation example: https://cwkevo.github.io/python-project-template\n\nThat should be it. Happy coding!\n\nIf you have any questions or found a bug, please open a new issue in this repository.\n\n\u003ca href=\"https://www.buymeacoffee.com/skevo\"\u003e\u003cimg src=\"https://img.buymeacoffee.com/button-api/?text=Support me\u0026emoji=🐣\u0026slug=skevo\u0026button_colour=ffa200\u0026font_colour=000000\u0026font_family=Poppins\u0026outline_colour=000000\u0026coffee_colour=FFDD00\" /\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskevo18%2Fpython-project-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskevo18%2Fpython-project-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskevo18%2Fpython-project-template/lists"}