{"id":19091997,"url":"https://github.com/allencellmodeling/cookiecutter-pypackage","last_synced_at":"2025-04-30T11:53:03.012Z","repository":{"id":54858617,"uuid":"169133667","full_name":"AllenCellModeling/cookiecutter-pypackage","owner":"AllenCellModeling","description":"A cookiecutter template to generate a new Python package.","archived":false,"fork":false,"pushed_at":"2021-01-24T21:47:35.000Z","size":541,"stargazers_count":23,"open_issues_count":1,"forks_count":7,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-19T01:32:38.553Z","etag":null,"topics":[],"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/AllenCellModeling.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-04T19:15:54.000Z","updated_at":"2024-11-06T09:21:48.000Z","dependencies_parsed_at":"2022-08-14T05:00:17.991Z","dependency_job_id":null,"html_url":"https://github.com/AllenCellModeling/cookiecutter-pypackage","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllenCellModeling%2Fcookiecutter-pypackage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllenCellModeling%2Fcookiecutter-pypackage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllenCellModeling%2Fcookiecutter-pypackage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllenCellModeling%2Fcookiecutter-pypackage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AllenCellModeling","download_url":"https://codeload.github.com/AllenCellModeling/cookiecutter-pypackage/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251693913,"owners_count":21628754,"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":[],"created_at":"2024-11-09T03:17:46.544Z","updated_at":"2025-04-30T11:53:02.971Z","avatar_url":"https://github.com/AllenCellModeling.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cookiecutter PyPackage\n\n[![Example Repo Status](https://github.com/AllenCellModeling/cookiecutter-pypackage/workflows/Build%20Example%20Repo/badge.svg)](https://github.com/AllenCellModeling/cookiecutter-pypackage/tree/example-build)\n\n![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)\n\nAICS Cookiecutter template for a Python package.\n\n## About\n\n`Cookiecutter` is a Python package to generate templated projects.\nThis repository is a template for `cookiecutter` to generate a Python project which\ncontains following:\n\n-   A directory structure for your project\n-   Prebuilt `setup.py` file to help you develop and install your package\n-   Includes examples of good Python practices, including tests\n-   Continuous integration\n    -   Preconfigured to generate project documentation\n    -   Preconfigured to automatically run tests every time you push to GitHub\n    -   Preconfigured to help you release your package publicly (PyPI)\n\nWe think that this template provides a good starting point for any Python project.\n\n## Features\n\n-   Uses `tox` (an environment manager) and `pytest` for local testing, simply run `tox`\n    or `make build` from a terminal in the project home directory\n-   Runs tests on Windows, Mac, and Ubuntu on every branch and pull request commit using\n    GitHub Actions\n-   Releases your Python Package to PyPI when you push to `main` after using\n    `bump2version`\n-   Automatically builds documentation using Sphinx on every push to main and deploys\n    to GitHub Pages\n-   Includes example code samples for objects, tests, and bin scripts\n\n## Example\n\n-   For an example of the base project that is built from this template, go to the\n    [example-build branch](https://github.com/AllenCellModeling/cookiecutter-pypackage/tree/example-build).\n\n## Quickstart\n\nTo use this template use the following commands and then follow the prompts from the\nterminal.\n\n1. `pip install cookiecutter`\n2. `cookiecutter gh:AllenCellModeling/cookiecutter-pypackage`\n\n## The Four Commands You Need To Know\n\n1. `pip install -e .[dev]`\n\n    This will install your package in editable mode with all the required development\n    dependencies (i.e. `tox`).\n\n2. `make build`\n\n    This will run `tox` which will run all your tests in both Python 3.7\n    and Python 3.8 as well as linting your code.\n\n3. `make clean`\n\n    This will clean up various Python and build generated files so that you can ensure\n    that you are working in a clean environment.\n\n4. `make docs`\n\n    This will generate and launch a web browser to view the most up-to-date\n    documentation for your Python package.\n\n#### Optional Steps:\n\n-   Turn your project into a GitHub repository:\n    -   Make an account on [github.com](https://github.com)\n    -   Go to [make a new repository](https://github.com/new)\n    -   _Recommendations:_\n        -   _It is strongly recommended to make the repository name the same as the Python\n            package name_\n        -   _A lot of the following optional steps are *free* if the repository is Public,\n            plus open source is cool_\n    -   After a GitHub repo has been created, run the commands listed under:\n        \"...or push an existing repository from the command line\"\n-   Register your project with Codecov:\n    -   Make an account on [codecov.io](https://codecov.io)(Recommended to sign in with GitHub)\n        everything else will be handled for you.\n-   Ensure that you have set GitHub pages to build the `gh-pages` branch by selecting the\n    `gh-pages` branch in the dropdown in the \"GitHub Pages\" section of the repository settings.\n-   Register your project with PyPI:\n    -   Make an account on [pypi.org](https://pypi.org)\n    -   Go to your GitHub repository's settings and under the `Secrets` tab, add a secret\n        called `PYPI_TOKEN` with your password for your PyPI account. Don't worry, no one\n        will see this password because it will be encrypted.\n    -   Next time you push to the branch: `main` after using `bump2version`, GitHub\n        actions will build and deploy your Python package to PyPI.\n\n#### Suggested Git Branch Strategy\n\n1. `main` is for the most up-to-date development, very rarely should you directly\n   commit to this branch. GitHub Actions will run on every push and on a CRON to this\n   branch but still recommended to commit to your development branches and make pull\n   requests to main. If you push a tagged commit with bumpversion, this will also release to PyPI.\n2. Your day-to-day work should exist on branches separate from `main`. Even if it is\n   just yourself working on the repository, make a PR from your working branch to `main`\n   so that you can ensure your commits don't break the development head. GitHub Actions\n   will run on every push to any branch or any pull request from any branch to any other\n   branch.\n3. It is recommended to use \"Squash and Merge\" commits when committing PR's. It makes\n   each set of changes to `main` atomic and as a side effect naturally encourages small\n   well defined PR's.\n\n**Original repo:** https://github.com/audreyr/cookiecutter-pypackage/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallencellmodeling%2Fcookiecutter-pypackage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallencellmodeling%2Fcookiecutter-pypackage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallencellmodeling%2Fcookiecutter-pypackage/lists"}