Google Git
Sign in
apache / airavata-django-portal-sdk / refs/tags/v1.7.0
tag016c363c06ba3b9891a43ca4cd11b2e859c2079f
taggerMarcus Christie <machristie@apache.org>Thu Dec 08 08:08:37 2022 -0500
objecte954a8432132388c5265fa057dd66db26a156e16 
v1.7.0
commite954a8432132388c5265fa057dd66db26a156e16[log] [tgz]
authorMarcus Christie <machristie@apache.org>Thu Dec 08 08:08:28 2022 -0500
committerMarcus Christie <machristie@apache.org>Thu Dec 08 08:08:28 2022 -0500
tree65704276da2cfecf4614c37f022803aef0ebaf6d
parent14c69b27969a73583dd12d4ece4d1091b8afeaf6 [diff]
Bump to version 1.7.0
1 file changed
tree: 65704276da2cfecf4614c37f022803aef0ebaf6d
  1. airavata_django_portal_sdk/
  2. docs/
  3. .gitignore
  4. .travis.yml
  5. LICENSE
  6. mkdocs.yml
  7. README.md
  8. requirements-dev.txt
  9. requirements.txt
  10. runtests.py
  11. setup.cfg
  12. setup.py
README.md

Airavata Django Portal SDK

Build Status

The Airavata Django Portal SDK provides libraries that assist in developing custom Django app extensions to the Airavata Django Portal.

See the documentation at https://airavata-django-portal-sdk.readthedocs.io/ for more details.

Getting Started

To integrate the SDK with an Airavata Django Portal custom app, add

airavata-django-portal-sdk

to the install_requires list in your setup.cfg or setup.py file. Then reinstall the Django app with

pip install -e .

(see your Airavata Django custom app's README for details)

You can also just install the library with:

pip install airavata-django-portal-sdk

Migrations

django-admin makemigrations --settings=airavata_django_portal_sdk.tests.test_settings airavata_django_portal_sdk

Documentation

To generate the documentation, create a virtual environment and then:

pip install -r requirements-dev.txt
mkdocs serve

Developing

Setting up dev environment

source venv/bin/activate
pip install -r requirements-dev.txt

Running tests

./runtests.py

or

django-admin test --settings airavata_django_portal_sdk.tests.test_settings

Running flake8

flake8 .

Automatically formatting Python code

autopep8 -i -aaa -r .
isort .

Making a new release

  1. Update the version in setup.py

  2. Tag the repo with the same version, with the format v${version_number}. For example, if the version number in setup.py is “1.2” then tag the repo with “v1.2”.

    VERSION=...
git tag -m $VERSION $VERSION
git push --follow-tags

  3. In a clean checkout

    cd /tmp/
git clone /path/to/airavata-django-portal-sdk/ -b $VERSION
cd airavata-django-portal-sdk
python3 -m venv venv
source venv/bin/activate
python3 -m pip install --upgrade build
python3 -m build

  4. Push to pypi.org. Optionally can push to test.pypi.org. See https://packaging.python.org/tutorials/packaging-projects/ for more info.

    python3 -m pip install --upgrade twine
python3 -m twine upload dist/*