{"id":19252400,"url":"https://github.com/ssciwr/cookiecutter-python-package","last_synced_at":"2025-04-21T13:30:57.367Z","repository":{"id":46733404,"uuid":"515112786","full_name":"ssciwr/cookiecutter-python-package","owner":"ssciwr","description":"A cookiecutter for a Python project with lots of configuration options","archived":false,"fork":false,"pushed_at":"2025-04-01T17:02:36.000Z","size":123,"stargazers_count":11,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-13T11:41:56.116Z","etag":null,"topics":["continuous-integration","cookiecutter","documentation","hacktoberfest","iwr-hacktoberfest","pypi","python"],"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/ssciwr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING.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}},"created_at":"2022-07-18T09:15:52.000Z","updated_at":"2025-01-09T12:29:35.000Z","dependencies_parsed_at":"2024-01-08T11:25:46.178Z","dependency_job_id":"2d7e6ab8-f1ae-4034-a373-7658549837ae","html_url":"https://github.com/ssciwr/cookiecutter-python-package","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/ssciwr%2Fcookiecutter-python-package","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssciwr%2Fcookiecutter-python-package/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssciwr%2Fcookiecutter-python-package/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssciwr%2Fcookiecutter-python-package/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ssciwr","download_url":"https://codeload.github.com/ssciwr/cookiecutter-python-package/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250064567,"owners_count":21368928,"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":["continuous-integration","cookiecutter","documentation","hacktoberfest","iwr-hacktoberfest","pypi","python"],"created_at":"2024-11-09T18:26:42.430Z","updated_at":"2025-04-21T13:30:56.803Z","avatar_url":"https://github.com/ssciwr.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Welcome to Python Package Cookiecutter!\n\nThis repository is a template repository (a cookiecutter) that allows you to quickly\nset up new Python packages. It is geared towards scientific applications and implements\nthe best practice guidelines of the [Scientific Software Center of Heidelberg University](https://ssc.iwr.uni-heidelberg.de).\n\n# Features\n\n* Very simple, configurable setup of a fully functional project\n* Modern build system metadata specification using `pyproject.toml` (PEP517 + PEP621)\n* Based on an established tool: [Cookiecutter](https://github.com/cookiecutter/cookiecutter) has \u003e17k stars on Github!\n* Package versioning integrated with Git repository using `setuptools_scm`\n* CI/CD configurations using Github Actions or Gitlab CI\n* Sphinx documentation deployed to [readthedocs.org](https://readthedocs.org)\n\nIf your Python package contains compiled C++ modules, you might want to check out our [C++ Cookiecutter with Pybind11 bindings](https://github.com/ssciwr/cookiecutter-cpp-project) instead.\n\n# Prerequisites\n\nIn order to use Python Package Cookiecutter you need the following software installed:\n\n* Python `\u003e= 3.8`\n* [Cookiecutter](https://github.com/cookiecutter/cookiecutter) e.g. by doing `pip install cookiecutter`.\n* Git `\u003e= 1.8.2`\n\n# Using the Python Package Cookiecutter\n\nSimply run the cookiecutter command line interface:\n\n```\ncookiecutter gh:ssciwr/cookiecutter-python-package\n```\n\nThis will start an interactive prompt that will configure and generate your project.\nOne of the prompts will ask you for a remote repository URL, so you should head to\nthe Git hosting service of your choice and add a new empty repository e.g. [on Github](https://github.com/new).\n\n# Configuration\n\nThis cookiecutter accepts the following configuration options:\n\n* `project_name`: The human-readable name of the project, defaults to `My Project`\n* `remote_url`: The remote URL for the newly created repository. This is not only used\n  to add it as a remote to the Git repository, but also to enable integration with some\n  services. Defaults to `None` although we strongly advise you to specify it.\n* `project_slug`: This will be the name of the generated directory.By default, it is deduced from the specified remote URL and the given project name.\n* `full_name`: Author name, defaults to `Your Name`\n* `license` adds a license file to the repository. It can be chosen from [MIT](https://opensource.org/licenses/MIT) (default), [BSD-2](https://opensource.org/licenses/BSD-2-Clause), [GPL-3.0](https://opensource.org/licenses/GPL-3.0), [LGPL-3.0](https://opensource.org/licenses/LGPL-3.0) or it can be omitted.\n* `github_actions_ci`: Whether to add CI/CD workflows for Github Actions\n* `gitlab_ci`: Whether to add a CI workflow for GitLab CI\n* `notebooks`: Whether you want to use Jupyter Notebooks for documentation, demonstration\n  and testing purposes. Will automatically render an example notebook into your Sphinx\n  documentation and run it during test suite execution.\n* `commandlineinterface`: Whether the Package should have a CLI based on `click`.\n\nIf you are using `cookiecutter-python-package` a lot, you can customize your default values\nby providing a `.cookiecutterrc` file in your home directory, for more details see the\n[cookiecutter documentation](https://cookiecutter.readthedocs.io/en/latest/advanced/user_config.html).\n\n# Issues\n\nPlease report any issues you might have with template using [the Github issue\ntracker](https://github.com/ssciwr/cookiecutter-python-package)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fssciwr%2Fcookiecutter-python-package","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fssciwr%2Fcookiecutter-python-package","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fssciwr%2Fcookiecutter-python-package/lists"}