Skip to main content
Documentation Status 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-Document-blue.svg https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Source_Code-blue.svg 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

cookiecutter is an awesome library that can create projects from templates. However, you need to create a working template first. People actually usually start with a concrete, working project, then convert it into a template for future use. cookiecutter_maker is a Python open source tool can convert any git repo into a cookiecutter projects template.

Usage:

from cookiecutter_maker.maker import Maker

maker = Maker.new(
    input_dir="/path-to-input-dir/my_awesome_project",
    output_dir="/path-to-output-dir",
    mapper=[
        ("my_awesome_project", "package_name"),
    ],
    include=[],
    exclude=[
        # dir
        ".venv",
        ".pytest_cache",
        ".git",
        ".idea",
        "build",
        "dist",
        "htmlcov",
        # file
        ".coverage",
    ],
    overwrite=True,
    debug=True,
)
maker.templaterize()

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.1.1

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

Source distribution (sdist)

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

Built distribution (wheel)

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

Total release size: 15.6 kB

Release files / cookiecutter_maker-0.1.1.tar.gz

Download URL cookiecutter_maker-0.1.1.tar.gz
Size 8.6 kB
Tags Source
SHA-256 checksum
How to use checksums
19900a568fe937e0e8e124c6d53816d8c1d91739442f0e124e0de334dd6e7911
BLAKE2b-256 checksum
How to use checksums
7009f9ad67e6b2e587b9579622061279dec468016b6b808571ddecf809c8811d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.13

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

Download URL cookiecutter_maker-0.1.1-py2.py3-none-any.whl
Size 7.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
5a6cb25e3116d3bca772dd2bcce44224280160dfd8c565daab67039dcc981ded
BLAKE2b-256 checksum
How to use checksums
9db203d85621514343887d5388cf4c2fc6e1b361dbcf07a4277b5cbf72c94d50
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.13

Security for cookiecutter_maker 0.1.1

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