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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for airavata-django-portal-sdk-1.1.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1c9c3b153a00bfc9d7ea6cc18b8492754d1ac5a735abdce9e93d2f0077dc633 |
|
MD5 | 57b01e3d616df356021127125c5e7888 |
|
BLAKE2b-256 | 09a9b150742b4e5d8b994c1684df07e1cb179e9b21f79c035941324d1ee02ea6 |
Hashes for airavata_django_portal_sdk-1.1.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3aaf12c9926ef3769780295df7248da43a7f35329ee0995f7bc0e60791f42f1 |
|
MD5 | 93b344c21caa1a8ebbd4dca6b58e5b38 |
|
BLAKE2b-256 | b4fbc33aaafd18000906b219696b35231548360fc824c03f2249c6278c237cf6 |