Skip to content

Commit 2d9bbf1

Browse files
committed
DEVELOPER.md: Update instructions to create a new release and push to PyPI
1 parent 68d9ffb commit 2d9bbf1

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

DEVELOPER.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,25 @@ There are a lot of instructions on the web that uses
1919
those are deprecated. The tool that seems to work for me is
2020
[Twine](https://github.com/pypa/twine).
2121

22-
[PyPI](https://pypi.python.org/pypi) does not support Markdown, so
23-
we use `pypandoc` and `pandoc` to convert Markdown to RST.
24-
`pypandoc` is a thin Python wrapper around `pandoc`.
22+
[PyPI](https://pypi.python.org/pypi) now supports Markdown so we no longer need
23+
to download `pypandoc` (Python package) and `pandoc` (apt package) to convert
24+
Markdown to RST.
2525

2626
Install the following packages:
2727
```
28-
$ sudo apt install pandoc
29-
$ sudo -H pip3 install setuptools wheel twine pypandoc
28+
$ sudo -H pip3 install setuptools wheel twine
3029
```
3130

3231
### Steps
3332

3433
1. Edit `setup.py` and increment the `version`.
3534
1. Push all changes to `develop` branch.
36-
1. Merge `develop` into `master` branch, and checkout the `master` branch.
35+
1. Create a GitHub pull request (PR) from `develop` into `master` branch.
36+
1. Merge the PR into `master`.
37+
1. Create a new Release in GitHub with the new tag label.
3738
1. Create the dist using `python3 setup.py sdist`.
38-
1. Upload to PyPI using `twine upload dist/*`.
39-
(Need to enter my PyPI login creddentials).
39+
1. Upload to PyPI using `twine upload
40+
dist/bigquery-schema-generator-{version}.tar.gz`.
41+
* Enter my PyPI login creddentials.
4042
* If `dist/` becomes too cluttered, we can remove the entire `dist/`
4143
directory and run `python3 setup.py sdist` again.
42-
1. Tag the `master` branch with the release on GitHub.

0 commit comments

Comments
 (0)