Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 1.41 KB

DEVELOPER.md

File metadata and controls

46 lines (37 loc) · 1.41 KB

Developer Notes

Installing for Local Testing

Use the -e option to install the bigquery_schema_generator package as "symlinks" so that changes to the code are picked up immediately, without having to run python setup.py install:

$ cd bigquery-schema-generator
$ pip3 install -e .

Uploading to PyPI

Preamble

There are a lot of instructions on the web that uses setup.py register and setup.py upload, but as far as I can tell, those are deprecated. The tool that seems to work for me is Twine.

PyPI now supports Markdown so we no longer need to download pypandoc (Python package) and pandoc (apt package) to convert Markdown to RST.

Install the following packages:

$ sudo -H pip3 install setuptools wheel twine

Steps

  1. Increment the version numbers in:
    • version.py
    • README.md
    • CHANGELOG.md
  2. Push all changes to develop branch.
  3. Create a GitHub pull request (PR) from develop into master branch.
  4. Merge the PR into master.
  5. Create a new Release in GitHub with the new tag label.
  6. Create the dist using python3 setup.py sdist.
  7. Upload to PyPI using twine upload dist/bigquery-schema-generator-{version}.tar.gz.
    • Enter my PyPI login credentials.
    • If dist/ becomes too cluttered, we can remove the entire dist/ directory and run python3 setup.py sdist again.