copier

Library and command-line utility for rendering projects templates.

Showing:

Popularity

Downloads/wk

0

GitHub Stars

398

Maintenance

Last Commit

1mo ago

Contributors

21

Package

Dependencies

12

License

MIT

Categories

Readme

Copier

Gitpod ready-to-code codecov CI Checked with mypy Code style: black Documentation Status

A library and CLI app for rendering project templates.

  • Works with local paths and git URLs.
  • Your project can include any file and Copier can dynamically replace values in any kind of text file.
  • It generates a beautiful output and takes care of not overwrite existing files unless instructed to do so.

Sample output

Installation

  1. Install Python 3.6.1 or newer (3.8 or newer if you're on Windows).
  2. Install Git 2.24 or newer.
  3. To use as a CLI app: pipx install copier
  4. To use as a library: pip install copier

Quick usage

  • Use it in your Python code:

    from copier import run_auto
    
    # Create a project from a local path
    run_auto("path/to/project/template", "path/to/destination")
    
    # Or from a git URL.
    run_auto("https://github.com/copier-org/copier.git", "path/to/destination")
    
    # You can also use "gh:" as a shortcut of "https://github.com/"
    run_auto("gh:copier-org/copier.git", "path/to/destination")
    
    # Or "gl:" as a shortcut of "https://gitlab.com/"
    run_auto("gl:copier-org/copier.git", "path/to/destination")
    
  • Or as a command-line tool:

    copier path/to/project/template path/to/destination
    

Basic concepts

Copier is composed of these main concepts:

  1. Templates. They lay out how to generate the subproject.
  2. Questionaries. They are configured in the template. Answers are used to generate projects.
  3. Projects. This is where your real program lives. But it is usually generated and/or updated from a template.

Copier targets these main human audiences:

  1. Template creators. Programmers that repeat code too much and prefer a tool to do it for them.

    !!! tip

     Copier doesn't replace the DRY principle... but sometimes you simply can't be
     DRY and you need a DRYing machine...
    
  2. Template consumers. Programmers that want to start a new project quickly, or that want to evolve it comfortably.

Non-humans should be happy also by using copier's CLI or API, as long as their expectations are the same as for those humans... and as long as they have feelings.

Templates have these goals:

  1. Code scaffolding. Help consumers have a working source code tree as quick as possible. All templates allow scaffolding.
  2. Code lifecycle management. When the template evolves, let consumers update their projects. Not all templates allow updating.

Copier tries to have a smooth learning curve that lets you create simple templates that can evolve into complex ones as needed.

Browse or tag public templates

You can browse public copier templates in GitHub using the copier-template topic. Use them as inspiration!

If you want your template to appear in that list, just add the topic to it! 🏷

Credits

Special thanks go to jpscaletti for originally creating Copier. This project would not be a thing without him.

Many thanks to pykong who took over maintainership on the project, promoted it, and laid out the bases of what the project is today.

Big thanks also go to Yajo for his relentless zest for improving Copier even further.

Thanks a lot, pawamoy for polishing very important rough edges and improving the documentation and UX a lot.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100