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 . `

### 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”.

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

Project details


Download files

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

Files for airavata-django-portal-sdk, version 1.2.2
Filename, size File type Python version Upload date Hashes
Filename, size airavata_django_portal_sdk-1.2.2-py3-none-any.whl (39.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size airavata-django-portal-sdk-1.2.2.tar.gz (33.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page