Skip to content

run copier with uvx and add --trust argument in quickstart.md #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tlambert03 merged 3 commits into from
Jun 5, 2025
Merged

run copier with uvx and add --trust argument in quickstart.md #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
88470d1
add uv install with --trust in quickstart.md
alisterburt Jun 4, 2025
21b2baa
update upload artifact action
alisterburt Jun 4, 2025
ff224ca
to v3...
alisterburt Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}

- name: ⬆️ Upload Pages Artifact
uses: actions/upload-pages-artifact@v1
uses: actions/upload-pages-artifact@v3
with:
path: "site/"

Expand Down
25 changes: 2 additions & 23 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,36 +38,15 @@ This guide will create a _new_ project directory.
`requirements-dev.txt`, `Makefile`, etc. You may also need to manually
update your CI config files to use the new project structure.

## Install Copier

First install [Copier](https://copier.readthedocs.io/en/stable/),
which we will use to run the project template.

<div class="termy">

```console
$ pip install copier
---> 100%
Successfully installed copier
```

</div>

!!!note
This will install Copier in your current Python environment. If you use
conda, make sure to `conda activate` the environment you want to use prior
to installing Copier. (It can be any environment... we're only going to
use copier once to create a new project.)

## Create a project

Next, run the following command to create a new project from the
Next, [install uv](https://docs.astral.sh/uv/getting-started/installation/) then run the following command to create a new project from the
[pydev-guide template](https://github.com/pydev-guide/pyrepo-copier).
Replace `<project-name>` with the desired path to your project, this
will be the name of the directory that will be created.

```bash
copier copy gh:pydev-guide/pyrepo-copier <project-name>
uvx copier copy --trust gh:pydev-guide/pyrepo-copier <project-name>
```

### Select a Mode
Expand Down