Skip to content

Commit ad567bf

Browse files
committed
First pass.
1 parent 1ddd9b8 commit ad567bf

1 file changed

Lines changed: 24 additions & 19 deletions

File tree

README.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,44 +5,45 @@
55
</div>
66
<!-- markdownlint-restore -->
77

8-
This repository collects the [UCL ARC] recommendations for a research software
9-
project in Python. It contains a template for new Python packages and a
10-
[website] documenting our recommendations. We've turned on
11-
[discussions](https://github.com/UCL-ARC/python-tooling/discussions) for this
12-
repo, and we welcome questions there or in the `#helpme` channel on the
13-
[UCL research programming hub Slack](https://www.ucl.ac.uk/advanced-research-computing/community/ucl-research-programming-hub).
8+
This repository collects the [UCL ARC] recommendations for a research software project in Python.
9+
It contains a template for new Python packages and a [website] documenting our recommendations.
1410

15-
🍪 Our template is a [cookiecutter] template which automatically creates new
16-
Python packages with our recommended tooling set up and ready to go.
11+
🍪 Our template uses [cookiecutter] to can create new Python packages with our preferred tools set up and ready to go.
1712

1813
> [!NOTE]
19-
> If you're making a package within a community that has an existing
20-
> package template (e.g., [`SciKit-Surgery`](https://github.com/SciKit-Surgery/PythonTemplate)),
21-
> we recommend using their template instead of this one.
14+
> If you're making a package within a community that has an existing template we recommend using their template instead!
2215
2316
## Using our Python package template
2417

25-
Some quick instructions for using our template are below.
18+
Here are some brief instructions if you're familiar with the command line.
2619
We also have a longer [tutorial](./tutorial.md) that has been presented in workshops for researchers at UCL.
2720

28-
If you have [uv] installed, you can use our template with the following command:
21+
If you have [uv] installed, you can run the following one-liner:
2922

3023
```sh
3124
uvx cookiecutter gh:ucl-arc/python-tooling --checkout latest
3225
```
3326

34-
If you don't want to use uv you can [install cookiecutter] using pip, and run the above command without the leading `uvx`.
27+
If you don't want to use uv you can [install cookiecutter], and run:
3528

36-
When [cookiecutter] runs, it will ask you a series of questions to configure your project.
37-
Type the answer or hit return without typing anything to use the default option (shown in parenthesis).
38-
At the end, it will print some more follow-up information in the terminal for things like creating a remote repository and making a website for your package.
29+
```sh
30+
cookiecutter gh:ucl-arc/python-tooling --checkout latest
31+
```
32+
33+
(The same as above without the `uvx`.)
34+
35+
[Cookiecutter] will ask you a series of questions to configure your project.
36+
Type the answer, or hit return without typing anything to use the default option (shown in parenthesis).
37+
38+
At the end, it prints some follow-up information to the terminal.
39+
These are tips for things like creating a repository and making a website for your package.
3940

4041
It will have created a directory for your project.
4142
You can see the structure with the `tree` command.
4243
In our example we've called our project `example-research-software-project`:
4344

4445
```sh
45-
ls -ltr | tail -n1 # Shows the last directory that was created
46+
ls -ltr | tail -n1 # Show the last directory that was created
4647
tree example-research-software-project
4748
```
4849

@@ -58,7 +59,9 @@ git init
5859
uv sync
5960
```
6061

61-
Note that `uv>=0.6.7` is required to use the `--group` option.
62+
## Need help?
63+
64+
We've turned on [discussions] for this repository, and we welcome questions there or in the `#helpme` channel on UCL's [Research Programming Hub Slack](.
6265

6366
<!-- links here -->
6467

@@ -68,6 +71,8 @@ Note that `uv>=0.6.7` is required to use the `--group` option.
6871
[cookiecutter]: https://cookiecutter.readthedocs.io/en/stable
6972
[install cookiecutter]: https://cookiecutter.readthedocs.io/en/stable/README.html#installation
7073
[uv]: https://docs.astral.sh/uv
74+
[discussions]: https://github.com/UCL-ARC/python-tooling/discussions
75+
[Research Programming Hub Slack]: https://www.ucl.ac.uk/advanced-research-computing/community/ucl-research-programming-hub
7176
<!-- prettier-ignore-end -->
7277

7378
## Contributors

0 commit comments

Comments
 (0)