Skip to content

Commit

Permalink
Docs: how to manually deploy to PyPi (#342)
Browse files Browse the repository at this point in the history
  • Loading branch information
Guts authored Nov 14, 2023
2 parents 6ab7b4f + 3c8d07d commit a7254e9
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/development/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,34 @@
1. Commit changes with a message like `Bump version to X.x.x` to the main branch
1. Apply a git tag with the relevant version: `git tag -a 0.3.0 {git commit hash} -m "New awesome feature"`
1. Push commit and tag to main branch: `git push --tags`

## Manual upload to PyPi

> This method requires an API token on PyPi
If the CI/CD fails for any reason, here comes the manual procedure:

1. Install required packages:

```sh
python -m pip install -U build twine wheel
```

1. Install package in editable mode:

```sh
python -m pip install -e .
```

1. Clean previous builds and build package artifacts:

```sh
rm -rf dist/
python -m build --no-isolation --sdist --wheel --outdir dist/ .
```

1. Upload built artifacts to PyPi:

```sh
twine upload -u __token__ dist/*
```

0 comments on commit a7254e9

Please sign in to comment.