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.

Sign up for GitHub

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

Add documentation on how to publish to pyPI for future reference #105

Merged
merged 1 commit into from
Oct 9, 2024
Merged

Add documentation on how to publish to pyPI for future reference #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions docs/guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,34 @@ pytest test_calibration.py
```
Make sure you have the development dependencies installed to use `pytest` (to do this install pySODM using the command `pip install -e ".[develop]"`)

### Publishing to pyPI

1. Make sure `build` and `twine` are installed. Open a terminal and run,

```bash
$ python -m pip install build twine
```

2. Build the distribution. Make sure you have set the intended new version in `setup.py`.

```bash
$ python -m build
```

3. Use `twine` to confirm your package build

```bash
$ twine check dist/*
```

4. Use `twine` to upload your package,

```bash
$ twine upload -r pySODM dist/*
```

Twine will ask you for your username and password. Nicked from [here](https://realpython.com/pypi-publish-python-package/).

### Documentation

#### Website
Expand Down
Loading