Home

Contributing

We are currently actively working on further developing py2cytoscape. If you would like to contribute please open an issue with your intentions so that we can avoid unnecessary overlaps.

Additions or changes will only be accepted if documentation is also added to the respective /docs folder. Docstrings are also expected for each function.

Pushing to pypi

Create a with ~/.pypirc with the following content:

[distutils]
index-servers =
  pypi
  pypitest

[pypi]
repository=https://upload.pypi.org/legacy/
username=<your username>
password=<your password>

[pypitest]
repository=https://testpypi.python.org/pypi
username=<your username>
password=<your password>

Make sure you have updated the version number in setup.py.

Make a new release.

Register and upload to pypi:

python setup.py register -r pypi
python setup.py sdist upload -r pypi

Alternative:

python setup.py sdist
twine upload dist/*

Documentation with ReadtheDocs

Edit the respective file in the /docs folder.

Make sure that for every function there is the

• description of the function and respective arguments
• description and example of input
• call
• description and example of output

To preview your changes offline:

cd py2cytoscape
mkdocs build
cd site 
jekyll serve