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
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
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.1.dev7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15b1e3849cc832ef8e9fb21bee45b698b77a35ce76c61ae1f5be3e01db5560c1 |
|
MD5 | cd8d70560f373048bbbd29fd7e9cfda3 |
|
BLAKE2b-256 | 69cce3435da893f8c2a6f0104fa51c8cbe18b2501bb4d4169190217ab9a8673d |
Hashes for airavata_django_portal_sdk-1.1.dev7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e1418cb064e8d087e9f6499691321378fb7078dcff37b1a5f0da353802a4e348 |
|
MD5 | 4b80e5aece3e517ed15154c93b4de3dd |
|
BLAKE2b-256 | 5cec551d79f613db8eaf5352d5548d2e3843b6b2df5f2f38fdb0856efd12f604 |