Skip to main content

The Airavata Django Portal SDK is a library that makes it easier to develop Airavata Django Portal customizations.

Project description

# Airavata Django Portal SDK

[![Build Status](https://travis-ci.com/apache/airavata-django-portal-sdk.svg?branch=master)](https://travis-ci.com/apache/airavata-django-portal-sdk)

The Airavata Django Portal SDK provides libraries that assist in developing custom Django app extensions to the [Airavata Django Portal](https://github.com/apache/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](https://docs.python.org/3/tutorial/venv.html) 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 . `

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airavata-django-portal-sdk-1.1.dev2.tar.gz (30.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file airavata-django-portal-sdk-1.1.dev2.tar.gz.

File metadata

  • Download URL: airavata-django-portal-sdk-1.1.dev2.tar.gz
  • Upload date:
  • Size: 30.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for airavata-django-portal-sdk-1.1.dev2.tar.gz
Algorithm Hash digest
SHA256 ad065ea5247f6fef906636d3e43acaf15fd667b1994dca9891fbe9722e8ddb4b
MD5 e1de1c20cc0970cc2cd73b7f3addc258
BLAKE2b-256 3a8500df8d2cc91488c99391feb17d1d245431756bcdf2f0120e9bdeda48f944

See more details on using hashes here.

File details

Details for the file airavata_django_portal_sdk-1.1.dev2-py3-none-any.whl.

File metadata

  • Download URL: airavata_django_portal_sdk-1.1.dev2-py3-none-any.whl
  • Upload date:
  • Size: 37.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for airavata_django_portal_sdk-1.1.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 928ee6e9f03b111c6135b49c7ce26a67a6b8a751aad4bc880e7e6e3cf5a36e04
MD5 69e3cfe080c6f484610b3b165d54ab8b
BLAKE2b-256 d905ce888ce2ab45bebade9f232cace9354eae8c2d521ba76fe57fd83583d531

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page