Airavata Django Portal SDK
The Airavata Django Portal SDK provides libraries that assist in developing custom Django app extensions to the 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
Developing
Setting up dev environment
To generate the documentation, create a virtual environment and then:
source venv/bin/activate
pip install --upgrade pip setuptools wheel
pip install -r requirements-dev.txt
Documentation
mkdocs serve
Running tests
pytest
or
django-admin test --settings airavata_django_portal_sdk.tests.test_settings
or use tox to run the tests in all supported Python environments
tox
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/*
3 maintainers
Release files for airavata-django-portal-sdk 1.8.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| airavata-django-portal-sdk-1.8.4.tar.gz | 41.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| airavata_django_portal_sdk-1.8.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:91.5 kB
Release files / airavata-django-portal-sdk-1.8.4.tar.gz
| Download URL | airavata-django-portal-sdk-1.8.4.tar.gz |
|---|---|
| Size | 41.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4a486d7f33ca6018d80d8b59e6d05fd2a105cdd3e62b23dde0b71cbd8d533528
|
|
BLAKE2b-256 checksum How to use checksums |
c88b22dab9a36bf22cd297e06b731ef76568436d957b641d1134da5a9a4121ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.9
|
Release files / airavata_django_portal_sdk-1.8.4-py3-none-any.whl
| Download URL | airavata_django_portal_sdk-1.8.4-py3-none-any.whl |
|---|---|
| Size | 50.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9e3d0be57a068ac57c8ebeb083dee4a5236865dc6e6c82b7c01d6e8db65d9b12
|
|
BLAKE2b-256 checksum How to use checksums |
e220bb96f0ee486e9e42c41262e8758eb8c6cf0b823cfb61651f6333bf8bec17
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.9
|
