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=airavata_django_portal_sdk.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 `
or
` django-admin test --settings airavata_django_portal_sdk.tests.test_settings `
### 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”.
` VERSION=... 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.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 991b2b52e7ba3124dbe9b5e990ada3cc03aafa6f65e18d86fdf9ec35b048c299 |
|
MD5 | 3c4103dc4f13e2df26fc4b299bf344d8 |
|
BLAKE2b-256 | da7aa833375e1f5dae8b0f37eabe209c16554701f80e10b0e1cbe0475f0c8076 |
Hashes for airavata_django_portal_sdk-1.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 523c9f56a448419a3a13159cf30004c4072dafb4f9155d3d7c184789ff766474 |
|
MD5 | 47eb11468e443ca0399cbc14c40e51bb |
|
BLAKE2b-256 | 3dea9e2341cf6aa5c37c0fc0fef9a0b82638e237e1f5c9efd35ef5c67efd95bf |