Skip to content

Commit

Permalink
Improve README a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
gwenwindflower authored Mar 5, 2024
1 parent 6bc04a1 commit 87c2363
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ Before embarking on this quick journey: if your data platform has a CLI tool tha
- `gh:` tells copier to use a GitHub repository as the source for the template

- The directory you specify is where the new project will be created, you don't need to create it beforehand, but do make sure there isn't already a directory with the same name there with work you don't want to mess up
- 🚨 `--trust` will allow copier to _**optionally**_ run a series of commands to set up your project after it templates everything. These are listed in the `copier.yml` at the bottom in the `_tasks` list, and they're detailed below. I highly encourage you to look through these before and make sure you really do trust and understand them before using the `--trust` flag above that will allow them to run. These commands are very straightforward and standard, this is very similar to using a project's `make` commands, `dbt init`, or other build scripts, but letting somebody's code run commands on your machine should always be considered carefully. They are chunked up logically into sections which can be **opted into**, they all default to `False` (no commands run, just templating). The command chunks the template can run for you are:
- 🚨 `--trust` will allow copier to _**optionally**_ run a series of commands to set up your project after it templates everything. These are listed in the `copier.yml` at the bottom in the `_tasks` list, and they're detailed below. I highly encourage you to look through these to make sure you really do trust and understand them before using the `--trust` flag above that will allow them to (potentially) run. These commands are very straightforward and standard, this is very similar to using a project's `make` commands, `dbt init`, or other build scripts, but letting somebody's code run commands on your machine should always be considered carefully. They are chunked up logically into sections which can be **opted _into_**, they all default to `False` (no commands run, just templating). The command chunks the template can run for you are:

- `virtual_environment` — Create and activate a virtual environment for the project in your newly templated project directory, install `uv`, compile a `requirements.txt`, and install those dependencies:
- `virtual_environment` — Create and activate a virtual environment for the project in your newly templated project directory, install `uv`, compile a `requirements.txt`, and install the dependencies from that file:

```bash
python3 -m venv <virual_environment_name>
Expand Down

0 comments on commit 87c2363

Please sign in to comment.