Skip to content

Commit 215445d

Browse files
committed
Add learning objectives and uv installation steps
1 parent 670a089 commit 215445d

File tree

2 files changed

+29
-43
lines changed

2 files changed

+29
-43
lines changed

index.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,18 @@
22
site: sandpaper::sandpaper_site
33
---
44

5-
This is a new lesson built with [The Carpentries Workbench][workbench].
5+
This workshop introduces the concepts of styling, linting, and formatting Python code for readability and collaboration. This content is for Python developers who want to write professional looking code that can be easily maintained and contributed to by others.
66

7+
## Learning Objectives
78

8-
[workbench]: https://carpentries.github.io/sandpaper-docs
9+
After attending this workshop, participants will be able to:
910

11+
- Write code that adheres to the Python style guide.
12+
- Check Python code for errors before running the code.
13+
- Format Python code for readability and maintenance.
14+
- Use the ruff tool to check (lint) and format Python code.
15+
- Use lint and formatter features in your editor or IDE for productive development.
16+
17+
:::::: prereq
18+
Prerequisites for this workshop include a basic understanding of how to use the terminal in macOS, Linux, or Windows. Familiarity with the uv tool for installing Python packages and command line tools. And of course a basic understanding of the Python programming language.
19+
::::::

learners/setup.md

Lines changed: 17 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,29 @@
22
title: Setup
33
---
44

5-
FIXME: Setup instructions live in this document. Please specify the tools and
6-
the data sets the Learner needs to have installed.
5+
## Installing uv
76

8-
## Data Sets
7+
The only requirement for this workshop is the uv tool. Detailed installation instructions are given in the [uv documentation](https://docs.astral.sh/uv/getting-started/installation/) but the main macOS, Linux, and Windows installation commands are presented below.
98

10-
<!--
11-
FIXME: place any data you want learners to use in `episodes/data` and then use
12-
a relative link ( [data zip file](data/lesson-data.zip) ) to provide a
13-
link to it, replacing the example.com link.
14-
-->
15-
Download the [data zip file](https://example.com/FIXME) and unzip it to your Desktop
9+
Install uv on macOS and Linux with:
1610

17-
## Software Setup
11+
```bash
12+
$ curl -LsSf https://astral.sh/uv/install.sh | sh
13+
```
1814

19-
::::::::::::::::::::::::::::::::::::::: discussion
15+
Install uv on Windows with:
2016

21-
### Details
17+
```bash
18+
$ powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
19+
```
2220

23-
Setup for different systems can be presented in dropdown menus via a `spoiler`
24-
tag. They will join to this discussion block, so you can give a general overview
25-
of the software used in this lesson here and fill out the individual operating
26-
systems (and potentially add more, e.g. online setup) in the solutions blocks.
21+
You may need to restart your terminal to ensure that uv was installed. Check the installation by displaying the version number using the `--version` option as shown below. If the command displays the uv version number then the installation was successful.
2722

28-
:::::::::::::::::::::::::::::::::::::::::::::::::::
23+
```bash
24+
$ uv --version
25+
```
2926

30-
:::::::::::::::: spoiler
31-
32-
### Windows
33-
34-
Use PuTTY
35-
36-
::::::::::::::::::::::::
37-
38-
:::::::::::::::: spoiler
39-
40-
### MacOS
41-
42-
Use Terminal.app
43-
44-
::::::::::::::::::::::::
45-
46-
47-
:::::::::::::::: spoiler
48-
49-
### Linux
50-
51-
Use Terminal
52-
53-
::::::::::::::::::::::::
27+
```output
28+
uv 0.8.4 (e176e1714 2025-07-30)
29+
```
5430

0 commit comments

Comments
 (0)