Skip to content
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.

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

Instances of tooling → template. #114

Merged
merged 2 commits into from
Jul 25, 2023
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
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

This is a Python package template for new ARC Python packages.
It automatically creates new Python packages with the recommended tooling set up and ready to go.
The recommended tooling is documented on the [UCL-ARC/python-template website](http://github-pages.arc.ucl.ac.uk/python-template/).
The recommended tooling is documented on the [UCL-ARC/python-tooling website](http://github-pages.arc.ucl.ac.uk/python-tooling/).

If you're making a package within a community that has an existing package template (e.g., [`scikit-hep`](https://github.com/scikit-hep/cookie)), we recommend using their template instead of this one.

Expand All @@ -18,11 +18,11 @@ If you're making a package within a community that has an existing package templ
```
2. Run cookieninja in the desired directory
```
cookieninja gh:ucl-arc/python-template
cookieninja gh:ucl-arc/python-tooling
```
If you have this repo locally (this may be the case if you are developing), you can alternatively run the following:
```
cookieninja /path/to/your/checkout/of/python-template
cookieninja /path/to/your/checkout/of/python-tooling
```
3. A series of questions will pop up to configure the project. Type the answer or hit return to use the default option (shown in square brackets).

Expand All @@ -31,7 +31,7 @@ If you're making a package within a community that has an existing package templ
email [[email protected]]:
github_username [UCL-ARC]:
project_name [Python Template]:
project_slug [python-template-cookiecutter]:
project_slug [python-tooling-cookiecutter]:
project_short_description [A cookieninja template with ARC recommendations.]:
version [0.1.0]:
Select min_python_version:
Expand All @@ -48,7 +48,7 @@ If you're making a package within a community that has an existing package templ
For example, for a project with the following variables:

```
project_slug [python-template-cookiecutter]: PROJECT_SLUG
project_slug [python-tooling-cookiecutter]: PROJECT_SLUG
project_name [Python Template]: PROJECT_NAME
```

Expand Down Expand Up @@ -88,5 +88,5 @@ If you're making a package within a community that has an existing package templ

- To run cookieninja using a specific branch of the template:
```
cookieninja https://github.com/UCL-ARC/python-template --checkout <branch-name>
cookieninja https://github.com/UCL-ARC/python-tooling --checkout <branch-name>
```
20 changes: 0 additions & 20 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,3 @@
# python-template

This repository documents common tooling we use in our Python projects in the [Advanced Research Computing center](https://www.ucl.ac.uk/arc/) (ARC) at [UCL](https://www.ucl.ac.uk).
It is designed as a static GitHub pages site.

## Contributing

The [website](https://ucl-arc.github.io/python-template/) and source pages are publicly available, but contributions are restricted to members and associate members of ARC.

Pages all live in the `pages` sub-directory, and are written in markdown.

To contribute:

1. Create a new branch.
2. Modify an existing page, or create a new one.
3. Open a pull request with changes.
4. Someone who did not contribute to the PR should review it.
5. If approved, the reviewer should merge the PR.
6. If changes requested, the PR author should address the comments, then ask for review again.

### Building locally

1. [Install jekyll](https://jekyllrb.com/docs/installation/)
Expand Down
4 changes: 2 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ title: UCL ARC Python tooling
description: Common Python tooling used in UCL's Advanced Research Computing center
theme: just-the-docs

url: https://UCL-ARC.github.io/python-template
url: https://UCL-ARC.github.io/python-tooling

aux_links:
Source repository: https://github.com/UCL-ARC/python-template
Source repository: https://github.com/UCL-ARC/python-tooling
2 changes: 1 addition & 1 deletion docs/pages/linting.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ layout: default

# Linting

See [here for example configuration](https://github.com/paddyroddy/python-template) for some of these.
See [here for example configuration](https://github.com/UCL-ARC/python-tooling/blob/main/%7B%7Bcookiecutter.project_slug%7D%7D/.pre-commit-config.yaml) for some of these.

## Code formatting

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ nav_order: 2

## Recommended ARC template

The [UCL-ARC/python-template](https://github.com/UCL-ARC/python-template) repository contains our recommended package template for new ARC projects.
This [UCL-ARC/python-tooling](https://github.com/UCL-ARC/python-tooling) repository contains our recommended package template for new ARC projects.
It pre-configures the recommended tools listed in the other pages of this site.
If you're making a package within one of the communities listed below, we recommend using their template instead.

Expand Down