{"id":13398271,"url":"https://github.com/pyscaffold/pyscaffold","last_synced_at":"2025-05-12T13:25:31.278Z","repository":{"id":15620934,"uuid":"18357535","full_name":"pyscaffold/pyscaffold","owner":"pyscaffold","description":"🛠 Python project template generator with batteries included","archived":false,"fork":false,"pushed_at":"2025-03-31T16:54:38.000Z","size":8277,"stargazers_count":2194,"open_issues_count":36,"forks_count":184,"subscribers_count":40,"default_branch":"master","last_synced_at":"2025-05-06T12:58:00.320Z","etag":null,"topics":["distribution","git","package","package-creation","project-template","python","release-automation","template-project"],"latest_commit_sha":null,"homepage":"https://pyscaffold.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pyscaffold.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"FlorianWilhelm","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":"https://www.paypal.me/FlorianWilhelm"}},"created_at":"2014-04-02T07:01:57.000Z","updated_at":"2025-05-05T20:59:26.000Z","dependencies_parsed_at":"2023-02-19T11:00:43.395Z","dependency_job_id":"de2bd9ef-ab36-4bab-a56d-91b63bec908e","html_url":"https://github.com/pyscaffold/pyscaffold","commit_stats":{"total_commits":2208,"total_committers":65,"mean_commits":33.96923076923077,"dds":0.5973731884057971,"last_synced_commit":"14ff8554f25c83845687315c0a251048e76784ba"},"previous_names":["blue-yonder/pyscaffold"],"tags_count":195,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyscaffold%2Fpyscaffold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyscaffold%2Fpyscaffold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyscaffold%2Fpyscaffold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyscaffold%2Fpyscaffold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyscaffold","download_url":"https://codeload.github.com/pyscaffold/pyscaffold/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253709082,"owners_count":21951102,"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":["distribution","git","package","package-creation","project-template","python","release-automation","template-project"],"created_at":"2024-07-30T19:00:21.547Z","updated_at":"2025-05-12T13:25:31.254Z","avatar_url":"https://github.com/pyscaffold.png","language":"Python","readme":".. image:: https://api.cirrus-ci.com/github/pyscaffold/pyscaffold.svg?branch=master\n    :alt: Built Status\n    :target: https://cirrus-ci.com/github/pyscaffold/pyscaffold\n.. image:: https://readthedocs.org/projects/pyscaffold/badge/?version=latest\n    :alt: ReadTheDocs\n    :target: https://pyscaffold.org/en/latest\n.. image:: https://img.shields.io/coveralls/github/pyscaffold/pyscaffold/master.svg\n    :alt: Coveralls\n    :target: https://coveralls.io/r/pyscaffold/pyscaffold\n.. image:: https://img.shields.io/pypi/v/pyscaffold.svg\n    :alt: PyPI-Server\n    :target: https://pypi.org/project/pyscaffold/\n.. image:: https://img.shields.io/conda/vn/conda-forge/pyscaffold.svg\n    :alt: Conda-Forge\n    :target: https://anaconda.org/conda-forge/pyscaffold\n.. image:: https://pepy.tech/badge/pyscaffold/month\n    :alt: Monthly Downloads\n    :target: https://pepy.tech/project/pyscaffold\n.. image:: https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026color=ff69b4\n    :alt: Sponsor me\n    :target: https://github.com/sponsors/FlorianWilhelm\n.. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social\u0026label=Twitter\n    :alt: Twitter\n    :target: https://twitter.com/pyscaffold\n.. image:: https://img.shields.io/badge/-PyScaffold?style=social\u0026logo=pyscaffold\u0026logoColor=005CA0\u0026label=PyScaffold\n    :alt: PyScaffold\n    :target: https://pyscaffold.org/\n\n|\n\n.. image:: https://pyscaffold.org/en/latest/_images/logo.png\n    :height: 512px\n    :width: 512px\n    :scale: 60 %\n    :alt: PyScaffold logo\n    :align: center\n\n|\n\nPyScaffold is a project generator for bootstrapping high quality Python\npackages, ready to be shared on PyPI_ and installable via pip_.\nIt is easy to use and encourages the adoption of the best tools and\npractices of the Python ecosystem, helping you and your team\nto stay sane, happy and productive. The best part? It is stable and has been used\nby thousands of developers for over half a decade!\n\nCheckout out `this demo project`_, which was set up using PyScaffold and\nif you are still not convinced yet, also have a look at these `reasons to use PyScaffold`_.\n\n\n    **NOTE** - This document refers to the latest version of PyScaffold (v4).\n    Please refer to `v3.3`_ for the previous stable version.\n\n\nQuickstart\n==========\n\nJust pick your favourite installation method::\n\n    ## Good old pip\n    # (make sure it is up-to-date: pip install -U pip setuptools)\n    pip install pyscaffold\n\n    ## Conda for the datascience fans\n    conda install -c conda-forge pyscaffold\n\n    ## Or even pipx for the virtualenv aficionados\n    pipx install pyscaffold\n\nIf you want to install all PyScaffold's *extensions* you can even::\n\n    pip install pyscaffold[all]\n\n(More details of each method are available in the `installation docs`_)\n\nAfter the installation, a new ``putup`` command will be available and you can just type::\n\n    putup my_project\n\nThis will create a new folder called ``my_project`` containing a perfect *project\ntemplate* with everything you need for some serious coding.\n\nAfter ``cd``-ing into your new project and creating (or activating) an `isolated\ndevelopment environment`_ (with virtualenv_, conda_ or your preferred tool),\nyou can do the usual `editable install`_::\n\n    pip install -e .\n\n… all set and ready to go!\n\nWe also recommend using tox_, so you can take advantage of the automation tasks\nwe have setup for you, like::\n\n   tox -e build  # to build your package distribution\n   tox -e publish  # to test your project uploads correctly in test.pypi.org\n   tox -e publish -- --repository pypi  # to release your package to PyPI\n   tox -av  # to list all the tasks available\n\nThe following figure demonstrates the usage of ``putup`` with the new experimental\ninteractive mode for setting up a simple project.\nIt uses the `--cirrus` flag to add CI support (via `Cirrus CI`_), and\ntox_ to run automated project tasks like building a package file for\ndistribution (or publishing).\n\n.. image:: https://pyscaffold.org/en/latest/_images/demo.gif\n    :alt: Creating a simple package with PyScaffold\n    :target: https://asciinema.org/a/qzh5ZYKl1q5xYEnM4CHT04HdW?autoplay=1\n\nType ``putup -h`` to learn about more configuration options. PyScaffold assumes\nthat you have Git_ installed and set up on your PC,\nmeaning at least your name and email are configured.\n\nThe project template provides you with following features:\n\n\nConfiguration \u0026 Packaging\n=========================\n\nAll configuration can be done in ``setup.cfg`` like changing the description,\nURL, classifiers, installation requirements and so on as defined by setuptools_.\nThat means in most cases it is not necessary to tamper with ``setup.py``.\n\nIn order to build a source or wheel distribution, just run ``tox -e build``\n(if you don't use tox_, you can also install ``build`` and run ``python -m build``).\n\n.. rubric:: Package and Files Data\n\nAdditional data, e.g. images and text files, that reside within your package and\nare tracked by Git will automatically be included\nif ``include_package_data = True`` in ``setup.cfg``.\nIt is not necessary to have a ``MANIFEST.in`` file for this to work.\n\nNote that the ``include_package_data`` option in ``setup.cfg`` is only\nguaranteed to be read when creating a `wheels`_ distribution. Other distribution methods might\nbehave unexpectedly (e.g. always including data files even when\n``include_package_data = False``). Therefore, the best option if you want to have\ndata files in your repository **but not as part of the pip installable package**\nis to add them somewhere **outside** the ``src`` directory (e.g. a ``files``\ndirectory in the root of the project, or inside ``tests`` if you use them for\nchecks). Additionally you can exclude them explicitly via the\n``[options.packages.find] exclude`` option in ``setup.cfg``.\n\n\nVersioning and Git Integration\n==============================\n\nYour project is an already initialised Git repository and uses\nthe information of tags to infer the version of your project with the help of\nsetuptools_scm_.\nTo use this feature, you need to tag with the format ``MAJOR.MINOR[.PATCH]``\n, e.g. ``0.0.1`` or ``0.1``.\nThis version will be used when building a package and is also accessible\nthrough ``my_project.__version__``.\n\nUnleash the power of Git by using its `pre-commit hooks`_. This feature is\navailable through the ``--pre-commit`` flag. After your project's scaffold\nwas generated, make sure pre-commit is installed, e.g. ``pip install pre-commit``,\nthen just run ``pre-commit install``.\n\nA default ``.gitignore`` file is also provided; it is\nwell adjusted for Python projects and the most common tools.\n\n\nSphinx Documentation\n====================\n\nPyScaffold will prepare a `docs` directory with all you need to start writing\nyour documentation.\nStart editing the file ``docs/index.rst`` to extend the documentation.\nThe documentation also works with `Read the Docs`_.\n\nThe `Numpy and Google style docstrings`_ are activated by default.\n\nIf you have `tox`_ in your system, simply run ``tox -e docs`` or ``tox -e\ndoctests`` to compile the docs or run the doctests.\n\nAlternatively, if you have `make`_ and `Sphinx`_ installed in your computer, build the\ndocumentation with ``make -C docs html`` and run doctests with\n``make -C docs doctest``. Just make sure Sphinx 1.3 or above is installed.\n\n\nAutomation, Tests \u0026 Coverage\n============================\n\nPyScaffold relies on `pytest`_ to run all automated tests defined in the subfolder\n``tests``.  Some sane default flags for pytest are already defined in the\n``[tool:pytest]`` section of ``setup.cfg``. The pytest plugin `pytest-cov`_ is used\nto automatically generate a coverage report. It is also possible to provide\nadditional parameters and flags on the commandline, e.g., type::\n\n    pytest -h\n\nto show the help of pytest (requires `pytest`_ to be installed in your system\nor virtualenv).\n\nProjects generated with PyScaffold by default support running tests via `tox`_,\na virtualenv management and test tool, which is very handy. If you run::\n\n    tox\n\nin the root of your project, `tox`_ will download its dependencies, build the\npackage, install it in a virtualenv and run the tests using `pytest`_, so you\nare sure everything is properly tested.\n\n\n.. rubric:: JUnit and Coverage HTML/XML\n\nFor usage with a continuous integration software JUnit and Coverage XML output\ncan be activated in ``setup.cfg``. Use the flag ``--cirrus`` to generate\ntemplates of the `Cirrus CI`_ configuration file ``.cirrus.yml`` which even\nfeatures the coverage and stats system `Coveralls`_.\n\n\nManagement of Requirements \u0026 Licenses\n=====================================\n\nInstallation requirements of your project can be defined inside ``setup.cfg``,\ne.g. ``install_requires = numpy; scipy``. To avoid package dependency problems\nit is common to not pin installation requirements to any specific version,\nalthough minimum versions, e.g. ``sphinx\u003e=1.3``, and/or maximum versions, e.g.\n``pandas\u003c0.12``, are used frequently in accordance with `semantic versioning`_.\n\nAll licenses from `choosealicense.com`_ can be easily selected with the help\nof the ``--license`` flag.\n\n\nExtensions\n==========\n\nPyScaffold comes with several extensions:\n\n* If you want a project setup for a *Data Science* task, just use ``--dsproject``\n  after having installed `pyscaffoldext-dsproject`_.\n\n* Have a ``README.md`` based on Markdown instead of ``README.rst`` by using\n  ``--markdown`` after having installed `pyscaffoldext-markdown`_.\n\n* Create a `Django project`_ with the flag ``--django`` which is equivalent to\n  ``django-admin startproject my_project`` enhanced by PyScaffold's features\n  (requires `pyscaffoldext-django`_).\n\n* … and many more like ``--gitlab`` to create the necessary files for GitLab_,\n  ``--travis`` for `Travis CI`_ (see `pyscaffoldext-travis`_), or\n  ``--cookiecutter`` for Cookiecutter_ integration (see `pyscaffoldext-cookiecutter`_).\n\nFind more extensions within the `PyScaffold organisation`_ and consider contributing your own,\nit is very easy! You can quickly generate a template for your extension with the\n``--custom-extension`` option after having installed `pyscaffoldext-custom-extension`_.\n\nAll extensions can easily be installed with ``pip install pyscaffoldext-NAME``.\n\nEasy Updating\n=============\n\nKeep your project's scaffold up-to-date by applying\n``putup --update my_project`` when a new version of PyScaffold was released.\nAn update will only overwrite files that are not often altered by users like\n``setup.py``. To update all files use ``--update --force``.\nAn existing project that was not setup with PyScaffold can be converted with\n``putup --force existing_project``. The force option is completely safe to use\nsince the git repository of the existing project is not touched!\n\n\n.. _v3.3: https://pyscaffold.org/en/v3.3.x/\n.. _PyPI: https://pypi.org/\n.. _pip: https://pip.pypa.io/en/stable/\n.. _this demo project: https://github.com/pyscaffold/pyscaffold-demo\n.. _reasons to use PyScaffold: https://pyscaffold.org/en/latest/reasons.html\n.. _installation docs: https://pyscaffold.org/en/latest/install.html\n.. _isolated development environment: https://realpython.com/python-virtual-environments-a-primer/\n.. also good, but sometimes medium can get on the way: https://towardsdatascience.com/virtual-environments-104c62d48c54\n.. _virtualenv: https://virtualenv.pypa.io/en/stable/\n.. _conda: https://docs.conda.io/en/latest/\n.. _editable install: https://pip.pypa.io/en/stable/cli/pip_install/#editable-installs\n.. _setuptools: https://setuptools.pypa.io/en/stable/userguide/declarative_config.html\n.. _setuptools_scm: https://pypi.org/project/setuptools-scm/\n.. _semantic versioning: https://semver.org\n.. _Git: https://git-scm.com/\n.. _PEP440: https://www.python.org/dev/peps/pep-0440/\n.. _pre-commit hooks: https://pre-commit.com/\n.. _make: https://www.gnu.org/software/make/\n.. _Sphinx: https://www.sphinx-doc.org/en/master/\n.. _Read the Docs: https://readthedocs.org/\n.. _Numpy and Google style docstrings: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html\n.. _pytest: https://docs.pytest.org/en/stable/\n.. _pytest-cov: https://github.com/pytest-dev/pytest-cov\n.. _Cirrus CI: https://cirrus-ci.org/\n.. _Travis CI: https://travis-ci.org/\n.. _Coveralls: https://coveralls.io/\n.. _tox: https://tox.wiki/en/stable/\n.. _choosealicense.com: https://choosealicense.com/\n.. _Django project: https://www.djangoproject.com/\n.. _Cookiecutter: https://cookiecutter.readthedocs.io/en/stable/\n.. _GitLab: https://about.gitlab.com/\n.. _pip-tools: https://github.com/jazzband/pip-tools/\n.. _pyscaffoldext-dsproject: https://github.com/pyscaffold/pyscaffoldext-dsproject\n.. _pyscaffoldext-custom-extension: https://github.com/pyscaffold/pyscaffoldext-custom-extension\n.. _pyscaffoldext-markdown: https://github.com/pyscaffold/pyscaffoldext-markdown\n.. _pyscaffoldext-django: https://github.com/pyscaffold/pyscaffoldext-django\n.. _pyscaffoldext-cookiecutter: https://github.com/pyscaffold/pyscaffoldext-cookiecutter\n.. _pyscaffoldext-travis: https://github.com/pyscaffold/pyscaffoldext-travis\n.. _PyScaffold organisation: https://github.com/pyscaffold/\n.. _wheels: https://realpython.com/python-wheels/\n","funding_links":["https://github.com/sponsors/FlorianWilhelm","https://www.paypal.me/FlorianWilhelm"],"categories":["Python","Development","Desktop App Development","Project Templates","Others","PyPi"],"sub_categories":["Time Series","Python Toolkit","Table of Content"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyscaffold%2Fpyscaffold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyscaffold%2Fpyscaffold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyscaffold%2Fpyscaffold/lists"}