Metadata-Version: 2.1
Name: copier
Version: 2.5.0
Summary: A library for rendering projects templates
Home-page: https://github.com/jpscaletti/copier
Author: Juan-Pablo Scaletti
Author-email: juanpablo@jpscaletti.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.5,<4.0
Description-Content-Type: text/markdown
Requires-Dist: jinja2 (~=2.10)
Requires-Dist: colorama (~=0.4)
Requires-Dist: toml (~=0.10)
Requires-Dist: ruamel.yaml (~=0.15)
Provides-Extra: docs
Provides-Extra: testing
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'
Requires-Dist: pytest-mock ; extra == 'testing'
Requires-Dist: pytest-flake8 ; extra == 'testing'
Requires-Dist: flake8 ; extra == 'testing'
Requires-Dist: ipdb ; extra == 'testing'
Requires-Dist: tox ; extra == 'testing'

![Copier](https://github.com/jpscaletti/copier/raw/master/copier-logotype.png)

[![](https://travis-ci.org/jpscaletti/copier.svg?branch=master)](https://travis-ci.org/jpscaletti/copier/) [![](https://img.shields.io/pypi/v/copier.svg)](https://pypi.python.org/pypi/copier) [![](https://img.shields.io/pypi/pyversions/copier.svg)](https://pypi.python.org/pypi/copier)

A library for rendering projects 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 files.
* It generates a beautiful output and take care of not overwrite existing files, unless instructed to do so.

![Sample output](https://github.com/jpscaletti/copier/raw/master/copier-output.png)


## How to use

- Use it in your Python code:

```python
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/jpscaletti/copier.git', 'path/to/destination')

# You can also use "gh:" as a shortcut of "https://github.com/"
copy('gh:jpscaletti/copier.git', 'path/to/destination')

# Or "gl:" as a shortcut of "https://gitlab.com/"
copy('gl:jpscaletti/copier.git', 'path/to/destination')
```

- Or as a command-line tool:

```bash
copier path/to/project/template path/to/destination
```


## How it works

The content of the files inside the project template are copied to the destination
without changes, **unless are suffixed with the extension '.tmpl'.**
In that case, the templating engine will be used to render them.

A slightly customized Jinja2 templating is used. The main difference is
that variables are referenced with ``[[ name ]]`` instead of
``{{ name }}`` and blocks are ``[% if name %]`` instead of
``{% if name %}``. To read more about templating see the [Jinja2
documentation](http://jinja.pocoo.org/docs>).

If a **YAML** file named `copier.yml` is found in the root of the
project (alternatively, a TOML file named `copier.toml`, or
a JSON file named `copier.json`), the user will be prompted to fill in or confirm the default values.

Use the `data` argument to pass whatever extra context you want to be available
in the templates. The arguments can be any valid Python value, even a
function.


## The copier.yml file

If a `copier.yml`, `copier.toml`, or `copier.json` file is found in the root of the project,
it will be read and used for two purposes:

### Prompt the user for information

For each key found, Copier will prompt the user to fill or confirm the values before
they become avaliable to the project template. So a content like this:

```yaml
name_of_the_project: My awesome project
number_of_eels: 1234
your_email: ""

```

will result in this series of questions:

```shell

   name_of_the_project? [My awesome project]
   your_email? [] myemail@gmail.com
   number_of_eels? [1234] 42
```

**NOTE:** All values are required. If you want some value to be optional, do not use an empty string as the default value or copier will not allow you to continue without answering with a value. Use `null` instead, so you can press ENTER to accept the "empty" default value.

```yaml
# DO NOT do this for optionals
optional_value: ""

# DO THIS instead
optional_value: null

```


### Arguments defaults

The keys `_exclude`, `_include`, `_skip_if_exists`, `_tasks`, and `_extra_paths` in the `copier.yml` file, will be treated as the default values for the `exclude`, `include`, `tasks`, and , `extra_paths` arguments to
`copier.copy()`.

Note that they become just *the defaults*, so any explicitely-passed argument will
overwrite them.

```yaml
# Shell-style patterns files/folders that must not be copied.
_exclude:
  - "*.bar"
  - ".git"
  - ".git/*"

# Shell-style patterns files/folders that *must be* copied, even if
# they are in the exclude list
_include:
  - "foo.bar"

# Shell-style patterns files to skip, without asking, if they already exists
# in the destination folder
_skip_if_exists:

# Commands to be executed after the copy
_tasks:
  - "git init"
  - "rm [[ name_of_the_project ]]/README.md"

# Additional paths, from where to search for templates
_extra_paths:
  - ~/Projects/templates

```

**Warning:** Use only trusted project templates as these tasks run with the same level of access as your user.

---

## API

#### copier.copy()

````python
copier.copy(
    src_path,
    dst_path,

    data=DEFAULT_DATA,
    *,
    exclude=DEFAULT_FILTER,
    include=DEFAULT_INCLUDE,
    skip_if_exists=[],
    tasks=[],

    envops={},
    extra_paths=[],

    pretend=False,
    force=False,
    skip=False,
    quiet=False,
    cleanup_on_error=True
)
````

Uses the template in *src_path* to generate a new project at *dst_path*.

**Arguments**:

- **src_path** (str):<br>
    Absolute path to the project skeleton. May be a version control system URL.

- **dst_path** (str):<br>
    Absolute path to where to render the skeleton.

- **data** (dict):<br>
    Data to be passed to the templates in addtion to the user data from
    a `copier.yml`.

- **exclude** (list):<br>
    A list of names or shell-style patterns matching files or folders
    that must not be copied.

    To exclude a folder you should use **two** entries, one for the folder and the other for its content: `[".git", ".git/*"]`.

- **include** (list):<br>
    A list of names or shell-style patterns matching files or folders that
    must be included, even if its name are a match for the `exclude` list.
    Eg: `['.gitignore']`. The default is an empty list.

- **skip_if_exists** (list):<br>
    Skip any of these files, without asking, if another with the same name already exists in the destination folder. (it only makes sense if you are copying to a folder that already exists).

- **tasks** (list):<br>
    Optional lists of commands to run in order after finishing the copy.
    Like in the templates files, you can use variables on the commands that will
    be replaced by the real values before running the command.
    If one of the commands fail, the rest of them will not run.

- **envops** (dict):<br>
    Extra options for the Jinja template environment.

- **extra_paths** (list):<br>
    Additional paths, from where to search for
    templates. This is intended to be used with shared parent templates, files
    with macros, etc. outside the copied project skeleton.

- **pretend** (bool):<br>
    Run but do not make any changes.

- **force** (bool):<br>
    Overwrite files that already exist, without asking.

- **skip** (bool):<br>
    Skip files that already exist, without asking.

- **quiet** (bool):<br>
    Suppress the status output.

- **cleanup_on_error** (bool):<br>
    Remove the destination folder if the copy process or one of the tasks fail. True by default.


