Skip to content

Commit eed57a6

Browse files
committed
update requirements + CONTRIBUTING
1 parent cce4909 commit eed57a6

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,31 @@ If there are autodoc issues/errors in remote builds of the docs, we need to add
7272

7373
## New releases [work in progress]
7474

75+
### Test release to `test.pypi.org` (manual)
76+
7577
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:
79+
```bash
80+
rm -rf dist
81+
python setup.py sdist
82+
twine upload --repository testpypi dist/*
83+
```
84+
3. At this point the updated build is available on test.pypi.org. We can test that this is working as expected by installing (into a test environment) from test.pypi.org with
85+
86+
```bash
87+
conda create -n causalpy-test python
88+
conda activate causalpy-test
89+
python3 -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ causalpy
90+
```
91+
92+
4. Now load a python or ipython session and follow the quickstart instructions to confirm things work.
93+
94+
### Actual release to `pypi.org` (manual)
95+
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`.
7697
2. Update on pypi.org. In the root directory:
7798
- `python setup.py sdist`
78-
- update to pypi.org with `twine upload dist/*`
99+
- update to pypi.org with `twine upload dist/*` Note that this requires username and password for pypi.org.
79100
3. Readthedocs:
80101
- Docs should be built remotely every time there is a pull request
81102
- See here https://docs.readthedocs.io/en/stable/tutorial/#versioning-documentation for versioning the docs

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
arviz>=0.13.0rc1
1+
arviz>=0.14.0
22
graphviz
33
matplotlib>=3.5.3
44
numpy

0 commit comments

Comments
 (0)