{"id":14065282,"url":"https://github.com/abilian/cookiecutter-abilian-python","last_synced_at":"2025-07-29T20:32:01.723Z","repository":{"id":45176634,"uuid":"312810576","full_name":"abilian/cookiecutter-abilian-python","owner":"abilian","description":"Cookiecutter template for a Python package.","archived":false,"fork":true,"pushed_at":"2023-12-22T17:41:06.000Z","size":653,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-13T07:08:32.331Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":false,"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/abilian.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-14T12:15:51.000Z","updated_at":"2023-04-20T02:33:09.000Z","dependencies_parsed_at":"2023-01-29T00:15:34.229Z","dependency_job_id":null,"html_url":"https://github.com/abilian/cookiecutter-abilian-python","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/abilian%2Fcookiecutter-abilian-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abilian%2Fcookiecutter-abilian-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abilian%2Fcookiecutter-abilian-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abilian%2Fcookiecutter-abilian-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abilian","download_url":"https://codeload.github.com/abilian/cookiecutter-abilian-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228046119,"owners_count":17861101,"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-08-13T07:04:24.491Z","updated_at":"2024-12-04T04:30:57.368Z","avatar_url":"https://github.com/abilian.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"======================\nCookiecutter PyPackage\n======================\n\n.. image:: https://pyup.io/repos/github/audreyfeldroy/cookiecutter-pypackage/shield.svg\n    :target: https://pyup.io/repos/github/audreyfeldroy/cookiecutter-pypackage/\n    :alt: Updates\n\n.. image:: https://travis-ci.org/audreyfeldroy/cookiecutter-pypackage.svg?branch=master\n    :target: https://travis-ci.org/github/audreyfeldroy/cookiecutter-pypackage\n    :alt: Build Status\n\n.. image:: https://readthedocs.org/projects/cookiecutter-pypackage/badge/?version=latest\n    :target: https://cookiecutter-pypackage.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\nCookiecutter_ template for a Python package.\n\n* GitHub repo: https://github.com/audreyfeldroy/cookiecutter-pypackage/\n* Documentation: https://cookiecutter-pypackage.readthedocs.io/\n* Free software: BSD license\n\nFeatures\n--------\n\n* Testing setup with ``unittest`` and ``python setup.py test`` or ``pytest``\n* Travis-CI_: Ready for Travis Continuous Integration testing\n* Tox_ testing: Setup to easily test for Python 3.6, 3.7, 3.8\n* Sphinx_ docs: Documentation ready for generation with, for example, `Read the Docs`_\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\nBuild Status\n-------------\n\nLinux:\n\n.. image:: https://img.shields.io/travis/audreyfeldroy/cookiecutter-pypackage.svg\n    :target: https://travis-ci.org/audreyfeldroy/cookiecutter-pypackage\n    :alt: Linux build status on Travis CI\n\nWindows:\n\n.. image:: https://ci.appveyor.com/api/projects/status/github/audreyr/cookiecutter-pypackage?branch=master\u0026svg=true\n    :target: https://ci.appveyor.com/project/audreyr/cookiecutter-pypackage/branch/master\n    :alt: Windows build status on Appveyor\n\nQuickstart\n----------\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/audreyfeldroy/cookiecutter-pypackage.git\n\nThen:\n\n* Create a repo and put it there.\n* Add the repo to your Travis-CI_ account.\n* Install the dev requirements into a virtualenv. (``pip install -r requirements_dev.txt``)\n* Register_ your project with PyPI.\n* Run the Travis CLI command ``travis encrypt --add deploy.password`` to encrypt your PyPI password in Travis config\n  and activate automated deployment on PyPI when you push a new tag to master branch.\n* Add the repo to your `Read the Docs`_ account + turn on the Read the Docs service hook.\n* Release your package by pushing a new tag to master.\n* Add a ``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* Activate your project on `pyup.io`_.\n\n.. _`pip docs for requirements files`: https://pip.pypa.io/en/stable/user_guide/#requirements-files\n.. _Register: https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives\n\nFor more details, see the `cookiecutter-pypackage tutorial`_.\n\n.. _`cookiecutter-pypackage tutorial`: https://cookiecutter-pypackage.readthedocs.io/en/latest/tutorial.html\n\nNot Exactly What You Want?\n--------------------------\n\nDon't worry, you have options:\n\nSimilar Cookiecutter Templates\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* `Nekroze/cookiecutter-pypackage`_: A fork of this with a PyTest test runner,\n  strict flake8 checking with Travis/Tox, and some docs and ``setup.py`` differences.\n\n* `tony/cookiecutter-pypackage-pythonic`_: Fork with py2.7+3.3 optimizations.\n  Flask/Werkzeug-style test runner, ``_compat`` module and module/doc conventions.\n  See ``README.rst`` or the `github comparison view`_ for exhaustive list of\n  additions and modifications.\n\n* `ardydedase/cookiecutter-pypackage`_: A fork with separate requirements files rather than a requirements list in the ``setup.py`` file.\n\n* `lgiordani/cookiecutter-pypackage`_: A fork of Cookiecutter that uses Punch_ instead of bump2version_ and with separate requirements files.\n\n* `briggySmalls/cookiecutter-pypackage`_: A fork using Poetry_ for neat package management and deployment, with linting, formatting, no makefiles and more.\n\n* `veit/cookiecutter-namespace-template`_: A cookiecutter template for python modules with a namespace\n\n* `zillionare/cookiecutter-pypackage`_: A template containing Poetry_, Mkdocs_, Github CI and many more. It's a template and a package also (can be installed with `pip`)\n\n* `waynerv/cookiecutter-pypackage`_: A fork using Poetry_, Mkdocs_, Pre-commit_, Black_ and Mypy_. Run test, staging and release workflows with GitHub Actions, automatically generate release notes from CHANGELOG.\n\n* Also see the `network`_ and `family tree`_ for this repo. (If you find\n  anything that should be listed here, please add it and send a pull request!)\n\nFork This / Create Your Own\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIf you have differences in your preferred setup, I encourage you to fork this\nto create your own version. Or create your own; it doesn't strictly have to\nbe a fork.\n\n* Once you have your own version working, add it to the Similar Cookiecutter\n  Templates list above with a brief description.\n\n* It's up to you whether or not to rename your fork/own version. Do whatever\n  you think sounds good.\n\nOr Submit a Pull Request\n~~~~~~~~~~~~~~~~~~~~~~~~\n\nI also accept pull requests on this, if they're small, atomic, and if they\nmake my own packaging experience better.\n\n\n.. _Travis-CI: http://travis-ci.org/\n.. _Tox: http://testrun.org/tox/\n.. _Sphinx: http://sphinx-doc.org/\n.. _Read the Docs: https://readthedocs.io/\n.. _`pyup.io`: https://pyup.io/\n.. _bump2version: https://github.com/c4urself/bump2version\n.. _Punch: https://github.com/lgiordani/punch\n.. _Poetry: https://python-poetry.org/\n.. _PyPi: https://pypi.python.org/pypi\n.. _Mkdocs: https://pypi.org/project/mkdocs/\n.. _Pre-commit: https://pre-commit.com/\n.. _Black: https://black.readthedocs.io/en/stable/\n.. _Mypy: https://mypy.readthedocs.io/en/stable/\n\n.. _`Nekroze/cookiecutter-pypackage`: https://github.com/Nekroze/cookiecutter-pypackage\n.. _`tony/cookiecutter-pypackage-pythonic`: https://github.com/tony/cookiecutter-pypackage-pythonic\n.. _`ardydedase/cookiecutter-pypackage`: https://github.com/ardydedase/cookiecutter-pypackage\n.. _`lgiordani/cookiecutter-pypackage`: https://github.com/lgiordani/cookiecutter-pypackage\n.. _`briggySmalls/cookiecutter-pypackage`: https://github.com/briggySmalls/cookiecutter-pypackage\n.. _`veit/cookiecutter-namespace-template`: https://github.com/veit/cookiecutter-namespace-template\n.. _`zillionare/cookiecutter-pypackage`: https://zillionare.github.io/cookiecutter-pypackage/\n.. _`waynerv/cookiecutter-pypackage`: https://waynerv.github.io/cookiecutter-pypackage/\n.. _github comparison view: https://github.com/tony/cookiecutter-pypackage-pythonic/compare/audreyr:master...master\n.. _`network`: https://github.com/audreyr/cookiecutter-pypackage/network\n.. _`family tree`: https://github.com/audreyr/cookiecutter-pypackage/network/members\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabilian%2Fcookiecutter-abilian-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabilian%2Fcookiecutter-abilian-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabilian%2Fcookiecutter-abilian-python/lists"}