Google Git
Sign in
apache / airavata-django-portal-sdk / refs/tags/v1.5.0
tagc6794f6b99ae9993f236f8f842bb88372f060aaa
taggerMarcus Christie <machristie@apache.org>Wed Aug 17 15:19:42 2022 -0400
objecteb903882e2e56505b6c429351bf239ceabf6d5cf 
v1.5.0
commiteb903882e2e56505b6c429351bf239ceabf6d5cf[log] [tgz]
authorMarcus Christie <machristie@apache.org>Wed Aug 17 15:19:17 2022 -0400
committerMarcus Christie <machristie@apache.org>Wed Aug 17 15:19:17 2022 -0400
treef955c60055bdffd4ba04cc4efd87192f3d036034
parent5b916d9bb84756db7f5b291f965d0bfe7c037090 [diff]
Bump to version 1.5.0
1 file changed
tree: f955c60055bdffd4ba04cc4efd87192f3d036034
  1. airavata_django_portal_sdk/
  2. docs/
  3. tests/
  4. .gitignore
  5. .travis.yml
  6. LICENSE
  7. mkdocs.yml
  8. README.md
  9. requirements-dev.txt
  10. requirements.txt
  11. runtests.py
  12. setup.cfg
  13. 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=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

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/*