{"id":16445685,"url":"https://github.com/vaibhavvikas/cookiecutter-pypackage","last_synced_at":"2026-06-15T15:31:51.203Z","repository":{"id":49380105,"uuid":"517502974","full_name":"vaibhavvikas/cookiecutter-pypackage","owner":"vaibhavvikas","description":"Cookiecutter template for a Python package. Docs using github pages.","archived":false,"fork":false,"pushed_at":"2022-07-25T09:09:53.000Z","size":44,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-26T09:47:10.238Z","etag":null,"topics":["cookiecutter","cookiecutter-github-pages","cookiecutter-python","cookiecutter-template","python"],"latest_commit_sha":null,"homepage":"http://vaibhavvikas.ml/cookiecutter-pypackage/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vaibhavvikas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-25T03:22:09.000Z","updated_at":"2023-07-15T04:53:10.000Z","dependencies_parsed_at":"2022-08-25T10:40:43.999Z","dependency_job_id":null,"html_url":"https://github.com/vaibhavvikas/cookiecutter-pypackage","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vaibhavvikas/cookiecutter-pypackage","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavvikas%2Fcookiecutter-pypackage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavvikas%2Fcookiecutter-pypackage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavvikas%2Fcookiecutter-pypackage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavvikas%2Fcookiecutter-pypackage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vaibhavvikas","download_url":"https://codeload.github.com/vaibhavvikas/cookiecutter-pypackage/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavvikas%2Fcookiecutter-pypackage/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34369840,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-github-pages","cookiecutter-python","cookiecutter-template","python"],"created_at":"2024-10-11T09:45:03.378Z","updated_at":"2026-06-15T15:31:51.025Z","avatar_url":"https://github.com/vaibhavvikas.png","language":"Python","funding_links":[],"categories":["python"],"sub_categories":[],"readme":"## Cookiecutter PyPackage\n\nCookiecutter template for a Python package.\n\n* GitHub repo: https://github.com/vaibhavvikas/cookiecutter-pypackage/\n* Free software: BSD license\n\n## Features\n\n* Testing setup with ``unittest`` and ``python setup.py test`` or ``pytest``\n* Tox_ testing: Setup to easily test for Python 3.6, 3.7, 3.8\n* Docs using github pages and Minimalistic theme\n* bump2version_: Pre-configured version bumping with a single command\n* Auto-release to PyPI_ when you push a new tag to master (optional)\n* Command line interface using Click (optional)\n\n*Cookiecutter: https://github.com/cookiecutter/cookiecutter*\n\n## Quickstart\n\nInstall the latest Cookiecutter if you haven't installed it yet (this requires\nCookiecutter 1.4.0 or higher):\n\n    pip install -U cookiecutter\n\nGenerate a Python package project:\n\n    cookiecutter https://github.com/vaibhavvikas/cookiecutter-pypackage.git\n\nThen:\n\n* Create a repo and put it there.\n* Install the requirements into a virtualenv. (``pip install -r requirements.txt``)\n* Register your project with PyPI.\n* Go to your project settings and activate GitHub pages and specifiy the docs folder for the documentations to be published at your github pages website.\n* Release your package by pushing a new tag to main.\n* In the ``requirements.txt`` file that specifies the packages you will need for\n  your project and their versions. For more info see the `pip docs for requirements files`.\n\npip docs for requirements files: https://pip.pypa.io/en/stable/user_guide/#requirements-files\n\nRegister: https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives\n\n\n## Setting up Github pages:\n\n* Go to repository settings and navigate to github pages from the sidebar.\n* In the source dropdown, select your default branch where you have the docs folder.\n* In the folder dropdown selct `\\docs`.\n* Click on `save`. The github action for github pages deployment will start after that you can check the github pages when its complete.\n\n## Known Issues:\n\nGithub Pages don't support the files or links of files outside the github pages folder i.e. you can't access files in the parent directory. As a result you'll need to copy the contents of the corresponding files from your main repo to the files inside docs folder. I know its kind of redundant. I will update if I find any solution. Suggestions are welcome (:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaibhavvikas%2Fcookiecutter-pypackage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvaibhavvikas%2Fcookiecutter-pypackage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaibhavvikas%2Fcookiecutter-pypackage/lists"}