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.cfg or setup.py file. Then reinstall the Django app with
` pip install -e . `
(see your Airavata Django custom app’s README for details)
You can also just install the library with:
` pip install airavata-django-portal-sdk `
## 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
Update the version in setup.py
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 `
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 `
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
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.3.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f0af0f362e325a71cccf26acc01f320f31cb3e14b51e4233a3492f89d51c48e |
|
MD5 | 9ecbe7341146b9ed3768a490fd493bbc |
|
BLAKE2b-256 | 9294beac7eb86cc6aa2645abade19eadce5e2a6e32e2718a426f4460fd8f89ad |
Hashes for airavata_django_portal_sdk-1.3.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0417c0c2f5751d4a37406ebcff86f907eb9c57bae9e5a1ea8723f0c4cd41e3f3 |
|
MD5 | 8aa70eeacec1d0b315b88d6f4e0aab5b |
|
BLAKE2b-256 | 95cbd32034d2a6aed0d485617e418226fd1e086c9c36b98fca88df52ae65751b |