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.dev3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3640cc1714e4b8d4c57c664a5d26978e188dcd04e9d9aa283bc48ed7620c28be |
|
MD5 | d9c2d3e878d1bec7de7fd6cf55485da5 |
|
BLAKE2b-256 | 11eefe1586b48ae412d5d6155717d970af4cdfd3a03c9b3812ae692df7657f66 |
Hashes for airavata_django_portal_sdk-1.1.dev3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7955d020cb5d9719598066fbe3187c0622d678790466e42cf6bc9c7feb90bbfe |
|
MD5 | c01a6a8084784aa682c4165e700ab93f |
|
BLAKE2b-256 | a5121827c6474c10929120dbe9aff1ffb9a00af2b79f1680fba12f8fb258e5f1 |