Skip to content

Commit 865d27c

Browse files
committed
Fix linting
1 parent 55af2cb commit 865d27c

File tree

1 file changed

+26
-21
lines changed

1 file changed

+26
-21
lines changed

python-packaging/index.qmd

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -643,10 +643,10 @@ overrides."tool.ruff.lint.isort.section-order".inline_arrays = false
643643
├── example_package_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
644644
└── example_package_YOUR_USERNAME_HERE-0.0.1.tar.gz
645645
```
646-
647-
The `tar.gz` file is a source distribution whereas the `.whl file` is a built
648-
distribution. Newer `pip` will install the built distribution and only use the
649-
source as a fallback.
646+
647+
The `tar.gz` file is a source distribution whereas the `.whl file` is a built
648+
distribution. Newer `pip` will install the built distribution and only use
649+
the source as a fallback.
650650

651651
3. Create an account on [TestPyPI](https://test.pypi.org/account/register/).
652652
4. Set up API token and so on.
@@ -656,14 +656,14 @@ overrides."tool.ruff.lint.isort.section-order".inline_arrays = false
656656
5. `python3 -m pip install --upgrade twine`
657657
6. `python3 -m twine upload --repository testpypi dist/*`
658658

659-
```text
660-
Uploading distributions to https://test.pypi.org/legacy/
661-
Enter your API token:
662-
Uploading example_package_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
663-
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 8.2/8.2 kB • 00:01 • ?
664-
Uploading example_package_YOUR_USERNAME_HERE-0.0.1.tar.gz
665-
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.8/6.8 kB • 00:00 • ?
666-
```
659+
```text
660+
Uploading distributions to https://test.pypi.org/legacy/
661+
Enter your API token:
662+
Uploading example_package_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
663+
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 8.2/8.2 kB • 00:01 • ?
664+
Uploading example_package_YOUR_USERNAME_HERE-0.0.1.tar.gz
665+
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.8/6.8 kB • 00:00 • ?
666+
```
667667

668668
7. `python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-package-YOUR-USERNAME-HERE`
669669

@@ -677,8 +677,10 @@ A similar set of steps can be done to upload to PyPI. TestPyPI allows one to
677677
test out their package. It is still public but much less obvious for people to
678678
look. People will often do these steps through GitHub Actions.
679679

680-
- [hynek/build-and-inspect-python-package](https://github.com/hynek/build-and-inspect-python-package) {{< fa brands github >}}
681-
- [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) {{< fa brands github >}}
680+
- [hynek/build-and-inspect-python-package](https://github.com/hynek/build-and-inspect-python-package)
681+
{{< fa brands github >}}
682+
- [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish)
683+
{{< fa brands github >}}
682684

683685
## PyPI {data-menu-title="PyPI (ii)" footer=false}
684686

@@ -698,23 +700,26 @@ look. People will often do these steps through GitHub Actions.
698700

699701
- Accessible guides: <https://www.pyopensci.org/python-package-guide>.
700702
- More technical guides: <https://packaging.python.org/en/latest/tutorials>.
701-
- Community recommended configuration: <https://scientific-python.github.io/repo-review>.
703+
- Community recommended configuration:
704+
<https://scientific-python.github.io/repo-review>.
702705

703706
## Resources {data-menu-title="Resources (ii)"}
704707

705708
- ARC Guide
706709
<!-- vale RedHat.TermsWarnings = NO -->
707-
- [UCL-ARC/python-tooling](https://github.com/UCL-ARC/python-tooling) {{< fa brands github >}}
708-
<!-- vale RedHat.TermsWarnings = YES -->
709-
- Tool recommendations: <https://github-pages.arc.ucl.ac.uk/python-tooling>.
710-
- Tutorial: <https://github.com/UCL-ARC/python-tooling/blob/main/docs/pages/tutorial.md>.
710+
- [UCL-ARC/python-tooling](https://github.com/UCL-ARC/python-tooling)
711+
{{< fa brands github >}}
712+
<!-- vale RedHat.TermsWarnings = YES -->
713+
- Tool recommendations: <https://github-pages.arc.ucl.ac.uk/python-tooling>.
714+
- Tutorial:
715+
<https://github.com/UCL-ARC/python-tooling/blob/main/docs/pages/tutorial.md>.
711716

712717
## Summary
713718

714719
- What a Python package is and when to make one.
715720
- How to structure your package.
716-
- How to make a `pyproject.toml` and the three different sections: `[build-system]`,
717-
`[project]` and `[tool]`.
721+
- How to make a `pyproject.toml` and the three different sections:
722+
`[build-system]`, `[project]` and `[tool]`.
718723
- How to upload your package to TestPyPI and PyPI.
719724
- Some resources including a tutorial to make your own package using the ARC
720725
cookiecutter.

0 commit comments

Comments
 (0)