Apache Airavata Django Portal SDK

Clone this repo:
  1. eedd030 AIRAVATA-3362 implementing remote api support for exp dir functions by Marcus Christie · 12 days ago master
  2. 7b48a60 Add data_product_uri parameter option to user_storage functions by Marcus Christie · 8 weeks ago
  3. 2c52fec adding CI badge by Marcus Christie · 3 months ago
  4. f44651e fixing typo by Marcus Christie · 3 months ago
  5. 015dff5 adding linting, import sorting by Marcus Christie · 3 months ago

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.py file. Then with your virtual environment activated, either install the SDK directly:

pip install -e "git+https://github.com/apache/airavata-django-portal-sdk.git@master#egg=airavata-django-portal-sdk"

Or add the dependency to your requirements.txt file:

-e "git+https://github.com/apache/airavata-django-portal-sdk.git@master#egg=airavata-django-portal-sdk"

then run pip install -r requirements.txt

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 .