Skip to content

Commit bc3697e

Browse files
committed
small elaboration of instructions to build pypi release
1 parent 6f3c4c5 commit bc3697e

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ If there are autodoc issues/errors in remote builds of the docs, we need to add
7575
### Test release to `test.pypi.org` (manual)
7676

7777
1. Bump the release version in `causalpy/version.py`. This is automatically read by `setup.py` and `docs/config.py`.
78-
2. Update on test.pypi.org. _Note that this requires username and password for test.pypi.org_. In the root directory type the following:
78+
2. Build locally and upload to test.pypi.org. _Note that this requires username and password for test.pypi.org_. In the root directory type the following:
7979
```bash
8080
rm -rf dist
8181
python setup.py sdist
@@ -93,10 +93,13 @@ python3 -m pip install --index-url https://test.pypi.org/simple/ --extra-index-u
9393

9494
### Actual release to `pypi.org` (manual)
9595

96-
1. If not done in the previous step, bump the release version in `causalpy/version.py`. This is automatically read by `setup.py` and `docs/config.py`.
97-
2. Update on pypi.org. In the root directory:
98-
- `python setup.py sdist`
99-
- update to pypi.org with `twine upload dist/*` Note that this requires username and password for pypi.org.
96+
1. Bump the release version (if not done in the previous step) in `causalpy/version.py`. This is automatically read by `setup.py` and `docs/config.py`.
97+
2. Build locally and upload to pypi.org. In the root directory:
98+
```bash
99+
rm -rf dist
100+
python setup.py sdist
101+
twine upload dist/*
102+
```
100103
3. Readthedocs:
101104
- Docs should be built remotely every time there is a pull request
102105
- See here https://docs.readthedocs.io/en/stable/tutorial/#versioning-documentation for versioning the docs

0 commit comments

Comments
 (0)