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.dev4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bab056d76944d24964bf7eafd0fcb63db73743b7fa6c9038e14e9f2898fa2aa9 |
|
MD5 | d0178c69f9f56f312e59047f23c9ef00 |
|
BLAKE2b-256 | f10927e0c543095eda2c606b9e3586bd6c8f6faaa9f93c89b6f8ea3bc89e0002 |
Hashes for airavata_django_portal_sdk-1.3.dev4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c62b932dd3367b8b0352e104868cd0f6eeda53a4c5e99ba67f0ee78e690d5a69 |
|
MD5 | db2f46c084a43a3f233d8bbe4d10a729 |
|
BLAKE2b-256 | d52f990990f08fc6044ef20551ee3d00ad17ddbf53d613c0da7a173c314d0237 |