Skip to main content

A library for rendering project templates.

Project description

Copier

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

A library 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 copy
    
    # Create a project from a local path
    copy("path/to/project/template", "path/to/destination")
    
    # Or from a git URL.
    copy("https://github.com/copier-org/copier.git", "path/to/destination")
    
    # You can also use "gh:" as a shortcut of "https://github.com/"
    copy("gh:copier-org/copier.git", "path/to/destination")
    
    # Or "gl:" as a shortcut of "https://gitlab.com/"
    copy("gl:copier-org/copier.git", "path/to/destination")
    
  • Or as a command-line tool:

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

copier-6.0.0a2.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

copier-6.0.0a2-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

Details for the file copier-6.0.0a2.tar.gz.

File metadata

  • Download URL: copier-6.0.0a2.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6

File hashes

Hashes for copier-6.0.0a2.tar.gz
Algorithm Hash digest
SHA256 a8643d2486bf85052f3e57ebb5374b2a1a804a103f49c2f975651a3c72e9d56c
MD5 2af14c655619661a4704440382371df5
BLAKE2b-256 ee59555e529a178aa9f75fa0faec13109d3490385bc7438b119e54cbd05abd2a

See more details on using hashes here.

File details

Details for the file copier-6.0.0a2-py3-none-any.whl.

File metadata

  • Download URL: copier-6.0.0a2-py3-none-any.whl
  • Upload date:
  • Size: 26.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6

File hashes

Hashes for copier-6.0.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 9f2e508e5012a0bb44d8da8a988ba86fc3eeddc607c58912bca924107f75188b
MD5 76f3a4049018a9f32822d426a1c903c7
BLAKE2b-256 ee57748dc6308bfc115db868864e9a68c08d071dace4706791b9bd22902ce3ac

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page