Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.65 KB

AmsterdamUMCdb CONTRIBUTING.md

Introduction

Thanks for considering contributing to AmsterdamUMCdb. This document is currently work in progress.

Testing

For code contributers and maintainers

Requirements

  • (local) installation of AmsterdamUMCdb in postgres
  • access to the BigQuery instance

Testing

Tests are currently developed using the Python unittest Unit testing framework package. Please make sure you are able to run the tests succesfully before submitting a pulling request:

python -m unittest -v

Publishing to PyPI

  1. Increase version number in setup.cfg
  2. Update Build tools

pip install --upgrade build

  1. Build the package

python -m build

  1. Get a PyPI API token: https://test.pypi.org/manage/account/#api-tokens

  2. Update Twine

pip install --upgrade twine

  1. Upload the package to TestPyPI:

python -m twine upload --repository testpypi dist/*

  1. Test the package

Since Colab is the main supported environment for the BigQuery instance, it is important to test the package from the getting_started.ipynb notebook:

Open In Colab

From the Install the AmsterdamUMCdb package cell, change the cell contents to:

# get the amsterdamumcdb package from TestPyPI repository for use in Colab
!pip install --index-url https://test.pypi.org/simple/ --no-deps amsterdamumcdb
import amsterdamumcdb as adb