{
    "info": {
        "author": "Anderson Bravalheri",
        "author_email": "andersonbravalheri@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Programming Language :: Python"
        ],
        "description": ".. image:: https://travis-ci.org/pyscaffold/pyscaffoldext-cookiecutter.svg?branch=master\n    :alt: Travis\n    :target: https://travis-ci.org/pyscaffold/pyscaffoldext-cookiecutter\n.. image:: https://readthedocs.org/projects/pyscaffoldext-cookiecutter/badge/?version=latest\n    :alt: ReadTheDocs\n    :target: https://pyscaffoldext-cookiecutter.readthedocs.io/\n.. image:: https://img.shields.io/coveralls/github/pyscaffold/pyscaffoldext-cookiecutter/master.svg\n    :alt: Coveralls\n    :target: https://coveralls.io/r/pyscaffold/pyscaffoldext-cookiecutter\n.. image:: https://img.shields.io/pypi/v/pyscaffoldext-cookiecutter.svg\n    :alt: PyPI-Server\n    :target: https://pypi.org/project/pyscaffoldext-cookiecutter/\n\n\n==========================\npyscaffoldext-cookiecutter\n==========================\n\n    Extension that combines the flexibility of **Cookiecutter** templates\n    with the power of **PyScaffold**.\n\n`Cookiecutter`_ is a flexible utility that allows the definition of templates\nfor a diverse range of software projects.\nOn the other hand, `PyScaffold`_ is focused in a good out-of-the-box experience\nfor developing distributable Python packages (exclusively).\nDespite the different objectives, it is possible to combine the power of both\ntools to create a custom Python project setup.\n\n\nQuickstart\n==========\n\nThis extension can be directly installed with ``pip``:\n\n.. code-block:: bash\n\n    $ pip install pyscaffoldext-cookiecutter\n\nOr, if you prefer ``pipx``:\n\n.. code-block:: shell\n\n   $ pipx install pyscaffold  # if you haven't installed pyscaffold yet\n   $ pipx inject pyscaffold pyscaffoldext-cookiecutter\n\nNote that, after the installation, ``putup -h`` will show a new option\n``--cookiecutter TEMPLATE``.\nUse this option to point out which template you want to use (path or url).\nThe file structure created by `Cookiecutter`_ will be refined by PyScaffold\nafterwards.\nFor example:\n\n.. code-block:: shell\n\n   $ putup my-proj1 --cookiecutter ~/my-templates/default\n   $ putup my-proj2 --cookiecutter gh:something/from-github\n\nPlease refer to `Cookiecutter`_ documentation for more details on possible URLs\nand abbreviations.\n\n\nCookiecutter templates with PyScaffold\n======================================\n\nThe following example shows how to create a new package named ``mypkg``,\nthat uses a Cookiecutter template, but is enhanced by PyScaffold's features:\n\n.. code-block:: bash\n\n    $ putup mypkg --cookiecutter gh:pyscaffold/cookiecutter-pypackage\n\nThis is roughly equivalent to first create a project using the Cookiecutter\ntemplate and convert it to PyScaffold afterwards:\n\n.. code-block:: bash\n\n    $ cookiecutter --no-input gh:pyscaffold/cookiecutter-pypackage project_name=mypkg\n    $ putup mypkg --force\n\n.. note::\n\n    For complex Cookiecutter templates calling ``cookiecutter`` and ``putup``\n    separately may be a better option, since it is possible to answer\n    specific template questions or at least set values for Cookiecutter\n    variables.\n\n.. warning::\n\n    Although using Cookiecutter templates is a viable solution to customize\n    a project that was set up with PyScaffold, the recommended way is to help\n    improve PyScaffold by contributing an `extension`_.\n\n\nSuitable templates\n------------------\n\nNote that PyScaffold will overwrite some files generated by Cookiecutter,\nlike ``setup.py``, the ``__init__.py`` file under the package folder\nand most of the ``docs`` folder, in order to provide `setuptools_scm`_\nand `sphinx`_ integration.\nTherefore not all Cookiecutter templates are suitable for this approach.\n\nIdeally, interoperable templates should focus on the file structure inside the\n``src`` folder instead of packaging or distributing, since PyScaffold already\nhandles it under-the-hood. This also means that your template should adhere to\nthe src-layout if you want to generate files within your Python package.\n\nIn addition, PyScaffold runs Cookiecutter with the ``--no-input`` flag\nactivated and thus the user is not prompted for manual configuration. Instead,\nPyScaffold injects the following parameters::\n\n    author\n    email\n    project_name\n    package_name\n    project_short_description\n\nAccordingly, the template file structure should be similar to::\n\n    cookiecutter-something/\n    \u2514\u2500\u2500 {{cookiecutter.project_name}}/\n        \u2514\u2500\u2500 src/\n            \u2514\u2500\u2500 {{cookiecutter.package_name}}/\n                \u2514\u2500\u2500 ...\n\nSee `Cookiecutter`_ for more information about template creation.\n\n.. note::\n\n   PyScaffold uses Cookiecutter only for its ability to create files.\n   Pre/post hooks that perform any other kind of side effect are not\n   guaranteed to work.\n\n\nNote\n====\n\nThis project has been set up using PyScaffold 3.2. For details and usage\ninformation on PyScaffold see https://pyscaffold.org/.\n\n\n.. _PyScaffold: https://pyscaffold.org\n.. _Cookiecutter: https://cookiecutter.readthedocs.org\n.. _setuptools_scm: https://pypi.python.org/pypi/setuptools_scm/\n.. _sphinx: http://www.sphinx-doc.org\n.. _extension: https://pyscaffold.org/en/latest/extensions.html\n\n\n",
        "description_content_type": "text/x-rst; charset=UTF-8",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://pyscaffold.org",
        "keywords": "",
        "license": "mit",
        "maintainer": "",
        "maintainer_email": "",
        "name": "pyscaffoldext-cookiecutter",
        "package_url": "https://pypi.org/project/pyscaffoldext-cookiecutter/",
        "platform": "any",
        "project_url": "https://pypi.org/project/pyscaffoldext-cookiecutter/",
        "project_urls": {
            "Documentation": "https://pyscaffold.org/",
            "Homepage": "https://pyscaffold.org"
        },
        "release_url": "https://pypi.org/project/pyscaffoldext-cookiecutter/0.1b1/",
        "requires_dist": [
            "pyscaffold (<4.1a0,>=4.0a1)",
            "cookiecutter",
            "flake8 ; extra == 'testing'",
            "flake8-bugbear ; extra == 'testing'",
            "pytest ; extra == 'testing'",
            "pytest-cov ; extra == 'testing'",
            "pytest-virtualenv ; extra == 'testing'",
            "pytest-xdist ; extra == 'testing'"
        ],
        "requires_python": "",
        "summary": "Integration of Cookiecutter project templates into PyScaffold (see: https://github.com/cookiecutter/cookiecutter)",
        "version": "0.1b1"
    },
    "last_serial": 5530906,
    "releases": {
        "0.1b1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "aa5f177c68d03b963ff0c32e235171e7",
                    "sha256": "4054bf3e42097ed125662cb61fd2b29946ef552db256585741c6ee98b503bb3e"
                },
                "downloads": -1,
                "filename": "pyscaffoldext_cookiecutter-0.1b1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "aa5f177c68d03b963ff0c32e235171e7",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 7381,
                "upload_time": "2019-07-14T12:51:26",
                "url": "https://files.pythonhosted.org/packages/0d/15/38fae753641908780992dcfc1a324ed465bb8477dbc5f20719442782d7a1/pyscaffoldext_cookiecutter-0.1b1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "1c2ab76eceaae1ab94f2294fc52dbf71",
                    "sha256": "0888ef454e125b96058c3c9d4dd2e656dcd99222e4bd52a884a674e63650d150"
                },
                "downloads": -1,
                "filename": "pyscaffoldext-cookiecutter-0.1b1.tar.gz",
                "has_sig": false,
                "md5_digest": "1c2ab76eceaae1ab94f2294fc52dbf71",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 20789,
                "upload_time": "2019-07-14T12:51:28",
                "url": "https://files.pythonhosted.org/packages/8c/a5/4b057c59f8db7db54044347dc54992f6b0e480b13036b01676979b29acd3/pyscaffoldext-cookiecutter-0.1b1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "aa5f177c68d03b963ff0c32e235171e7",
                "sha256": "4054bf3e42097ed125662cb61fd2b29946ef552db256585741c6ee98b503bb3e"
            },
            "downloads": -1,
            "filename": "pyscaffoldext_cookiecutter-0.1b1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "aa5f177c68d03b963ff0c32e235171e7",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 7381,
            "upload_time": "2019-07-14T12:51:26",
            "url": "https://files.pythonhosted.org/packages/0d/15/38fae753641908780992dcfc1a324ed465bb8477dbc5f20719442782d7a1/pyscaffoldext_cookiecutter-0.1b1-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "1c2ab76eceaae1ab94f2294fc52dbf71",
                "sha256": "0888ef454e125b96058c3c9d4dd2e656dcd99222e4bd52a884a674e63650d150"
            },
            "downloads": -1,
            "filename": "pyscaffoldext-cookiecutter-0.1b1.tar.gz",
            "has_sig": false,
            "md5_digest": "1c2ab76eceaae1ab94f2294fc52dbf71",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 20789,
            "upload_time": "2019-07-14T12:51:28",
            "url": "https://files.pythonhosted.org/packages/8c/a5/4b057c59f8db7db54044347dc54992f6b0e480b13036b01676979b29acd3/pyscaffoldext-cookiecutter-0.1b1.tar.gz"
        }
    ]
}