{"id":15017509,"url":"https://github.com/giswqs/pypackage","last_synced_at":"2025-10-06T16:32:35.990Z","repository":{"id":62412231,"uuid":"312933537","full_name":"giswqs/pypackage","owner":"giswqs","description":"Cookiecutter template creating a Python package with mkdocs","archived":false,"fork":true,"pushed_at":"2023-07-31T04:40:30.000Z","size":1134,"stargazers_count":47,"open_issues_count":2,"forks_count":18,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-16T17:44:55.791Z","etag":null,"topics":["cookiecutter","cookiecutter-template","mkdocs","mkdocs-material","python","template","template-project"],"latest_commit_sha":null,"homepage":"https://giswqs.github.io/pypackage","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"audreyfeldroy/cookiecutter-pypackage","license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/giswqs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"giswqs","custom":["buymeacoffee.com/giswqs"]}},"created_at":"2020-11-15T01:14:25.000Z","updated_at":"2024-07-31T09:50:09.000Z","dependencies_parsed_at":"2023-02-12T12:15:29.794Z","dependency_job_id":null,"html_url":"https://github.com/giswqs/pypackage","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/giswqs%2Fpypackage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/giswqs%2Fpypackage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/giswqs%2Fpypackage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/giswqs%2Fpypackage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/giswqs","download_url":"https://codeload.github.com/giswqs/pypackage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235538025,"owners_count":19006071,"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":["cookiecutter","cookiecutter-template","mkdocs","mkdocs-material","python","template","template-project"],"created_at":"2024-09-24T19:50:35.132Z","updated_at":"2025-10-06T16:32:35.615Z","avatar_url":"https://github.com/giswqs.png","language":"Python","funding_links":["https://github.com/sponsors/giswqs","buymeacoffee.com/giswqs"],"categories":[],"sub_categories":[],"readme":"# Cookiecutter PyPackage\n\n[![image](https://github.com/giswqs/pypackage/workflows/build/badge.svg)](https://github.com/giswqs/pypackage/actions?query=workflow%3Abuild)\n[![image](https://github.com/giswqs/pypackage/workflows/docs/badge.svg)](https://giswqs.github.io/pypackage)\n\n[Cookiecutter](https://github.com/cookiecutter/cookiecutter) template for a Python package.\n\n-   GitHub repo: \u003chttps://github.com/giswqs/pypackage\u003e\n-   Documentation: \u003chttps://giswqs.github.io/pypackage\u003e\n-   Free software: BSD license\n\n## Features\n\n-   Testing setup with `unittest` and `python setup.py test` or `pytest`\n-   GitHub actions: Ready for GitHub Continuous Integration testing\n-   [bump2version](https://github.com/c4urself/bump2version): Pre-configured version bumping with a single command\n-   Auto-release to [PyPI](https://pypi.python.org/pypi) when you push a new tag to master (optional)\n-   Command line interface using Click (optional)\n\n## Quickstart\n\nInstall the latest Cookiecutter if you haven't installed it yet (this\nrequires Cookiecutter 1.4.0 or higher):\n\n    pip install -U cookiecutter\n\nGenerate a Python package project:\n\n    cookiecutter gh:giswqs/pypackage\n\nThen:\n\n-   Create a repo and put it there.\n-   Go to [GitHub Settings - Workflow permissions](https://github.com/giswqs/mapwidget/settings/actions) and enable Read and write permissions for GitHub Actions.\n-   Install the dev requirements into a virtualenv. (`pip install -r requirements_dev.txt`)\n-   [Register](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives) your project with PyPI.\n-   Release your package by pushing a new tag to master.\n-   Add a `requirements.txt` file that specifies the packages you will\n    need for your project and their versions. For more info see the [pip\n    docs for requirements files](https://pip.pypa.io/en/stable/user_guide/#requirements-files).\n\n## Video Tutorials\n\n**1. Creating a Python package with Cookiecutter Template**\n\n[![](http://img.youtube.com/vi/DAPAv9KbYZ0/0.jpg)](http://www.youtube.com/watch?v=DAPAv9KbYZ0)\n\n**2. Publishing Python packages on PyPI**\n\n[![](http://img.youtube.com/vi/7FcX9uWDuIQ/0.jpg)](http://www.youtube.com/watch?v=7FcX9uWDuIQ)\n\n**3. Deploying Python packages to PyPI using GitHub Actions**\n\n[![](http://img.youtube.com/vi/oayticDOZmU/0.jpg)](http://www.youtube.com/watch?v=oayticDOZmU)\n\n**4. Introduction to Python package file structure**\n\n[![](http://img.youtube.com/vi/0eLt_O6sIYU/0.jpg)](http://www.youtube.com/watch?v=0eLt_O6sIYU)\n\n## Not Exactly What You Want?\n\nDon't worry, you have options:\n\n### Similar Cookiecutter Templates\n\n-   [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage): Cookiecutter template for a Python package.\n\n### Fork This / Create Your Own\n\nIf you have differences in your preferred setup, I encourage you to fork\nthis to create your own version. Or create your own; it doesn't strictly\nhave to be a fork.\n\n-   Once you have your own version working, add it to the Similar\n    Cookiecutter Templates list above with a brief description.\n-   It's up to you whether or not to rename your fork/own version. Do\n    whatever you think sounds good.\n\n### Or Submit a Pull Request\n\nI also accept pull requests on this, if they're small, atomic, and if\nthey make my own packaging experience better.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiswqs%2Fpypackage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgiswqs%2Fpypackage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiswqs%2Fpypackage/lists"}