Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ repos:
additional_dependencies:
- pytest
- repo: https://github.com/rbubley/mirrors-prettier
rev: v3.5.3
rev: v3.6.2
hooks:
- id: prettier
args:
Expand Down
2 changes: 1 addition & 1 deletion tests/data/test_package_generation/.pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ repos:
hooks:
- id: mypy
- repo: https://github.com/rbubley/mirrors-prettier
rev: v3.5.3
rev: v3.6.2
hooks:
- id: prettier
args:
Expand Down
3 changes: 0 additions & 3 deletions tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## ⚙️ Setting up dependencies for using template

<details><summary>Click to expand... </summary> <!-- markdownlint-disable-line MD033 -->

Check failure on line 10 in tutorial.md

View workflow job for this annotation

GitHub Actions / vale

[vale] tutorial.md#L10

[proselint.Typography] Consider using the '…' symbol instead of '...'.
Raw output
{"message": "[proselint.Typography] Consider using the '…' symbol instead of '...'.", "location": {"path": "tutorial.md", "range": {"start": {"line": 10, "column": 34}}}, "severity": "ERROR"}

To use the template you will need to install the following software tools

Expand All @@ -22,7 +22,6 @@
An easy way to install and manage Python packages is using `uv`, which can create a dedicated environment with the necessary packages installed using the step by step instructions below

1. Open a terminal window

- On Windows: open the Start menu from the taskbar, type `cmd` in the search field, then click [command prompt](https://en.wikipedia.org/wiki/Command-line_interface#Command_prompt) from the results.
- On MacOS: click the Launchpad icon in the Dock, type `Terminal` in the search field, then click `Terminal` from the results.
- On Linux: open the default terminal application installed in your distribution.
Expand Down Expand Up @@ -52,7 +51,6 @@
```

to authenticate the GitHub command line interface tool `gh` with your GitHub account credentials. The tool will ask you a series of question, for most of which you can select the default options by just hitting the `Enter` key. Specifically select:

- `GitHub.com` for account to log into,
- `HTTPS` for preferred protocol,
- `Y` to authenticate Git with your GitHub credentials,
Expand Down Expand Up @@ -94,7 +92,6 @@

in both cases replacing `{project_slug}` with the relevant value you used (`python-template` if you used the default values).
Some of the key files and directories are

- The `README.md` file which is a Markdown file describing the project and acting as a landing page for first-time users.
- The `LICENSE.md` file which contains the terms of the open-source license the code is released under.
- The `src` directory which will contain the Python package source code.
Expand Down Expand Up @@ -198,7 +195,7 @@

It is recommended to set up a project-specific [virtual environment](https://docs.python.org/3/tutorial/venv.html) whenever working on Python project. This allows you to install the versions of third-party packages the project requires without conflicting with the requirements of other projects you are developing.

There are a variety of virtual environment management tools available for Python. One option is [uv](https://docs.astral.sh/uv), which you will have installed if you followed our detailed set-up instructions above, or may already have installed previously. `uv` is an extremely fast Python package and virtual environment manager that has API compatiblility with `pip` and the built-in virtual environment manager - [`venv`](https://docs.python.org/3/library/venv.html).

Check failure on line 198 in tutorial.md

View workflow job for this annotation

GitHub Actions / vale

[vale] tutorial.md#L198

[write-good.ThereIs] Don't start a sentence with 'There are'.
Raw output
{"message": "[write-good.ThereIs] Don't start a sentence with 'There are'.", "location": {"path": "tutorial.md", "range": {"start": {"line": 198, "column": 1}}}, "severity": "ERROR"}

Check warning on line 198 in tutorial.md

View workflow job for this annotation

GitHub Actions / vale

[vale] tutorial.md#L198

[write-good.Weasel] 'extremely' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'extremely' is a weasel word!", "location": {"path": "tutorial.md", "range": {"start": {"line": 198, "column": 269}}}, "severity": "WARNING"}

Once you are in your `{project_slug}` directory, a virtual environment can be created by running the following in a terminal/command prompt window

Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/.pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ repos:
hooks:
- id: mypy
- repo: https://github.com/rbubley/mirrors-prettier
rev: v3.5.3
rev: v3.6.2
hooks:
- id: prettier
args:
Expand Down
Loading