Skip to content

Latest commit

 

History

History
50 lines (43 loc) · 1.66 KB

dev.md

File metadata and controls

50 lines (43 loc) · 1.66 KB
Raw

Development Guide

img

Modified: 2021-03

Packaging and Deploying

This repository hosts the iris-stage client package. It is hosted on pypi and can be installed on any machine using pip:

python3 -m pip install iris-stage

Here I will describe how we build and publish new package distributions based on this guide:

  1. First you will need a pypi and testpypi account, if you do not have both of these you will need to create these accounts.
  2. Create a .pypirc file in the home directory with the following structure replacing USERNAME and PASSWORD with your account credentials: 
    [distutils]
index-servers =
    pypi
    testpypi

[pypi]
repository: https://upload.pypi.org/legacy/
username: USERNAME
password: PASSWORD

[testpypi]
repository: https://test.pypi.org/legacy/
username: USERNAME
password: PASSWORD
  3. Write some updates on a feature branch and create a pull request into master. Ensure your code passes CI.
  4. After it is merged into master increment the version number appropriately in here
  5. Build the distribution: 
    ./scripts/build.sh
  6. Publish the distribution to the testpypi repository: 
    ./scripts/publish.sh testpypi
  7. Test installing the package from testpypi 
    python3 -m pip install --no-cache -i https://test.pypi.org/simple/ iris-stage
  8. After validating the package works push to pypi: 
    ./scripts/publish.sh pypi