@@ -42,10 +42,15 @@ First, open a Terminal and move into the directory where you want to
4242create the new Python package. Then run the following command:
4343
4444``` bash
45- # Copy into the current directory, which is the "."
46- uvx copier copy --trust gh:seedcase-project/template-python-package .
45+ uvx copier copy --trust gh:seedcase-project/template-python-package new-package
4746```
4847
48+ Here, ` new-package ` is the name of the new folder you will create from
49+ the template. The template assumes that the name of your new folder will
50+ also be the name of the GitHub repository for the Python package. So the
51+ new folder name should be a short, lowercase name without spaces or
52+ special characters.
53+
4954::: callout-caution
5055This template runs some post-copy commands using your terminal. In order
5156to run them, you need to use the ` --trust ` option. Review the
@@ -64,12 +69,13 @@ to the existing package. This will add all the template's files and
6469configurations to the existing package.
6570
6671``` bash
67- uvx copier copy --trust gh:seedcase-project/template-python-package .
72+ uvx copier copy --trust gh:seedcase-project/template-python-package new-package
6873```
6974
70- It will go through a series of prompts, as in the case of creating a new
71- Python package, including asking if you want to overwrite existing
72- files.
75+ See the comment above in the "Creating a new Python package" section
76+ about naming the new folder. It will go through a series of prompts, as
77+ in the case of creating a new Python package, including asking if you
78+ want to overwrite existing files.
7379
7480::: callout-note
7581To use the ` copy ` command, the Python package needs to be tracked by Git
@@ -129,8 +135,8 @@ just install-precommit
129135This sets up the pre-commit hooks to run standard checks on your
130136repository whenever you commit files to the history.
131137
132- If you are using the template to create a Python package for the Seedcase
133- Project, run:
138+ If you are using the template to create a Python package for the
139+ Seedcase Project, run:
134140
135141``` bash
136142just update-quarto-theme
@@ -140,9 +146,9 @@ Then set `seedcase-theme` as your project `type` in `_quarto.yml`.
140146
141147This adds the ` seedcase-theme ` Quarto theme to the website, which
142148provides a consistent look and feel across all Seedcase Project
143- websites, including for Python package websites.
144- It's called ` update-quarto-theme ` here since you can use this
145- command to keep the theme updated.
149+ websites, including for Python package websites. It's called
150+ ` update-quarto-theme ` here since you can use this command to keep the
151+ theme updated.
146152
147153Next, install [ ` spaid ` ] ( https://github.com/seedcase-project/spaid ) and
148154use the following commands to run the next setup steps:
@@ -175,5 +181,5 @@ additional setup are:
175181 GitHub App, along with the ` ADD_TO_BOARD_TOKEN ` secret and the
176182 ` ADD_TO_BOARD_APP_ID ` variable of the GitHub App's ID.
177183
178- If you use Netlify, you will also need to add a ` NETLIFY_AUTH_TOKEN ` secret
179- of your Netlify Token.
184+ If you use Netlify, you will also need to add a ` NETLIFY_AUTH_TOKEN `
185+ secret of your Netlify Token.
0 commit comments