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

Rename package and CLI program to stravavis #3

Merged
merged 2 commits into from
Feb 6, 2022
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
65 changes: 65 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Release Checklist

- [ ] Get `main` to the appropriate code release state.

- [ ] Update `version` in `setup.cfg` and commit and push.

* [ ] Start from a freshly cloned repo:

```bash
cd /tmp
rm -rf strava_py
git clone https://github.com/marcusvolz/strava_py
cd strava_py
```

* [ ] (Optional) Create a distribution and release on **TestPyPI**:

```bash
python -m pip install -U pip build keyring twine
rm -rf build dist
python -m build
twine check --strict dist/* && twine upload --repository-url https://test.pypi.org/legacy/ dist/*
```

- [ ] (Optional) Check **test** installation:

```bash
python -m pip uninstall -y stravavis
python -m pip install -U -i https://test.pypi.org/simple/ stravavis
stravavis --help
```

* [ ] Tag with the version number:

```bash
git tag -a v0.0.1 -m "Release 0.0.1"
```

* [ ] Create a distribution and release on **live PyPI**:

```bash
python -m pip install -U pip build keyring twine
rm -rf build dist
python -m build
twine check --strict dist/* && twine upload -r pypi dist/*
```

* [ ] Check installation:

```bash
python -m pip uninstall -y stravavis
python -m pip install -U stravavis
stravavis --help
```

* [ ] Push tag:
```bash
git push --tags
```

* [ ] Create a new release: https://github.com/marcusvolz/strava_py/releases/new

* [ ] Click "Choose a tag" and select newest.

* [ ] Click "Auto-generate release notes", amend as required and "Publish release".
4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[metadata]
name = strava_py
name = stravavis
version = 0.0.1
description = Create artistic visualisations with your exercise data
long_description = file: README.md
Expand Down Expand Up @@ -47,4 +47,4 @@ where = src

[options.entry_points]
console_scripts =
strava_py = strava_py.cli:main
stravavis = strava_py.cli:main