Commit d65f2efb authored by Christophe Benz's avatar Christophe Benz
Browse files

Add section about proxies

parent 8c64a3f9
Pipeline #149312 failed with stage
in 1 minute and 1 second
......@@ -10,6 +10,10 @@ A tutorial is available as a [Jupyter notebook](./index.ipynb).
The "Binder" tool allows you to run it interactively in your browser. Click on [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/git/https%3A%2F%2Fgit.nomics.world%2Fdbnomics%2Fdbnomics-python-client.git/master?filepath=index.ipynb) then wait a couple of seconds. After loading a list of files should be displayed. Click on `index.ipynb` to open the tutorial notebook, where you'll be able to play with the DBnomics Python client.
### Use with a proxy
This Python package uses [requests](https://requests.readthedocs.io/), which is able to work with a proxy (HTTP/HTTPS, SOCKS). For more information, please check [its documentation](https://requests.readthedocs.io/en/master/user/advanced/#proxies).
## Install
```bash
......@@ -68,6 +72,7 @@ API_URL=http://localhost:5000 pytest
## Release
To release a version on PyPI:
- merge one or many feature branches into master (no need to do a release for every feature...)
- update `setup.py` incrementing the package version (we use Semantic Versioning so determine if it's a major, minor or patch increment)
- ensure the changelog is up to date
......@@ -75,4 +80,4 @@ To release a version on PyPI:
- create a Git tag with a `v` before version number and push it (`git tag v1.2.0; git push; git push --tags`)
- the [CI](./.gitlab-ci.yml) will run a job to publish the package on PyPI at https://pypi.org/project/DBnomics/
It's advised to do `pip install -e .` to let your virtualenv know about the new version number.
\ No newline at end of file
It's advised to do `pip install -e .` to let your virtualenv know about the new version number.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment