Skip to main content
Release file added late

1 file was added to this release more than 14 days after its initial publication. Inspect the release files before installing.

https://github.com/MacHu-GWU/cookiecutter_maker-project/workflows/CI/badge.svg https://codecov.io/gh/MacHu-GWU/cookiecutter_maker-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/cookiecutter_maker.svg https://img.shields.io/pypi/l/cookiecutter_maker.svg https://img.shields.io/pypi/pyversions/cookiecutter_maker.svg https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to cookiecutter_maker Documentation

Summary

Python Cookiecutter is an awesome library that can create projects from templates. In an enterprise setting, people typically start with a concrete, working project and then convert it into a template that serves as the internal standard for future use (Template -> Project).

📋 Cookiecutter Maker is the inverse of cookiecutter (Project -> Template). It is a Python open source tool that can convert any given folder structure into a cookiecutter project.

Usage Example

Run the following python script to convert your concrete project into a template project:

from cookiecutter_maker.api import Maker

maker = Maker.new(
    # the input concrete project directory
    input_dir="/path-to-input-dir/my_awesome_project",
    # the output template project directory
    output_dir="/path-to-output-dir",
    # define the ``string to replace``, ``parameter name`` and ``default parameter value``
    mapper=[
        ("my_awesome_project", "package_name", "default_package_name"),
    ],
    # define what to include in the input directory
    # it is the relative path from the input directory
    # the rule is 'explicit exclude' > 'explicit include' > 'default include'
    # if empty, then include all files and directories
    include=[],
    # define what to exclude in the input directory
    # it is the relative path from the input directory
    exclude=[
        # dir
        ".venv",
        ".pytest_cache",
        ".git",
        ".idea",
        "build",
        "dist",
        "htmlcov",
        # file
        ".coverage",
    ],
    # define what to copy as it is without rending
    # usually you should ignore jinja template files
    no_render=[
        "*.tpl",
    ],
    # over write the output location if already exists
    overwrite=True,
    # mapper could have one key is substring of another key
    # if this is True, it will ignore the error
    ignore_mapper_error=False,
    # when mapper could have one key is substring of another key
    # it will prompt you to confirm to continue
    skip_mapper_prompt=True,
    # do you want to print debug information?
    debug=True,
)
maker.templaterize()

In this example, it will create a directory {{ cookiecutter.package_name }} and a json file cookiecutter.json. Now you can follow the cookiecutter instruction to generate more concrete projects.

Install

cookiecutter_maker is released on PyPI, so all you need is:

$ pip install cookiecutter_maker

To upgrade to latest version:

$ pip install --upgrade cookiecutter_maker

Metadata

Release files for cookiecutter_maker 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

File added late

1 file was uploaded more than 14 days after the first file in this release.

While project maintainers occasionally add legitimate files to an existing release, late additions can also indicate a security compromise.

We recommend inspecting the release files before installing.

Source distribution (sdist)

Source distribution for cookiecutter_maker 0.3.1
File Size Uploaded Provenance Actions
cookiecutter_maker-0.3.1.tar.gz 13.3 kB Without provenance Details for cookiecutter_maker-0.3.1.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for cookiecutter_maker 0.3.1
File Interpreter ABI Platform Actions
cookiecutter_maker-0.3.1-py3-none-any.whl Python 3 none any Details for cookiecutter_maker-0.3.1-py3-none-any.whl
cookiecutter_maker-0.3.1-py2.py3-none-any.whl Python 2, Python 3 none any Details for cookiecutter_maker-0.3.1-py2.py3-none-any.whl

Total release size: 41.6 kB

Release files / cookiecutter_maker-0.3.1.tar.gz

Download URL cookiecutter_maker-0.3.1.tar.gz
Size 13.3 kB
Tags Source
SHA-256 checksum
How to use checksums
6958d5a969641df276b0d2440ee941737dc2580aca21f8e77b207d48739d7791
BLAKE2b-256 checksum
How to use checksums
d20f9d74cc7db37cfc82a5eef56d5e1161653daa906d6daefc9c83c7fa0c2fd7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.11

Release files / cookiecutter_maker-0.3.1-py3-none-any.whl

File added late

This file was uploaded more than 14 days after the first file in this release.

While project maintainers occasionally add legitimate files to an existing release, late additions can also indicate a security compromise.

We recommend inspecting the release file before installing.

Download URL cookiecutter_maker-0.3.1-py3-none-any.whl
Size 19.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
52b323b1e315da92892b5c4c11b6289a413d80f7ff35733d13c10ee2b7666a0b
BLAKE2b-256 checksum
How to use checksums
eae1a1d438a1369202d52ba18f28024f55d51a7410d6bde71ee55807f873a2ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.8

Release files / cookiecutter_maker-0.3.1-py2.py3-none-any.whl

Download URL cookiecutter_maker-0.3.1-py2.py3-none-any.whl
Size 9.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
1823843fcbff1b7367adaaac3e48bcb044d8b594a6b560f6a8da690706fbe411
BLAKE2b-256 checksum
How to use checksums
b23dcf5390c200e4dcca4a3cf8c090dba6baf0ab7743b9568d3fc674ca3e1835
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.11

Security for cookiecutter_maker 0.3.1

Upload timing

Release file added late

1 file was uploaded more than 14 days after the first file in this release.

While project maintainers occasionally add legitimate files to an existing release, late additions can also indicate a security compromise.


Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page