Skip to content

Commit 04fc397

Browse files
committed
clean up publishing doc
1 parent c2918b1 commit 04fc397

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

publishing.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,30 @@ Publishing notes
55

66
To develop and test, see the "Developer Installation" in the README.
77

8+
Notes:
9+
- `setup.py` uses `setuptools-markdown` which requires having installed:
10+
```
11+
brew install pandoc
12+
pip3 install setuptools-markdown
13+
```
14+
15+
- Make sure your `~/.pypirc` points to correct credentials. E.g.
16+
```
17+
index-servers =
18+
pypitodbotdotcom
19+
20+
[pypitodbotdotcom]
21+
username=todbotdotcom
22+
password=....
23+
```
24+
825
To publish:
926
1027
1. Edit `setup.py` to bump version
11-
2. Check changes into git
12-
3. Publish to PyPI
28+
2. Update README.md (use `pydoc blink1.blink1.Blink1 > api.txt` to generate new API ref)
29+
3. Check changes into git
30+
4. Publish to PyPI with:
1331
```
14-
python3 setup.py sdist upload -r pypitodbotdotcom # or whatever your repo is called
32+
python3 setup.py sdist upload -r pypitodbotdotcom
1533
```
1634
4. Verify new version on PyPi: https://pypi.org/project/blink1/
17-
18-
19-
Note `setup.py` uses `setuptools-markdown` which requires having installed:
20-
```
21-
brew install pandoc
22-
pip3 install setuptools-markdown
23-
```
24-
25-
Make sure your `~/.pypirc` points to correct credentials. E.g.
26-
```
27-
index-servers =
28-
pypitodbotdotcom
29-
30-
[pypitodbotdotcom]
31-
username=todbotdotcom
32-
password=....

0 commit comments

Comments
 (0)