The Airavata Django Portal SDK is a library that makes it easier to develop Airavata Django Portal customizations.
Project description
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/*
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
File details
Details for the file airavata-django-portal-sdk-1.8.4.tar.gz.
File metadata
- Download URL: airavata-django-portal-sdk-1.8.4.tar.gz
- Upload date:
- Size: 41.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4a486d7f33ca6018d80d8b59e6d05fd2a105cdd3e62b23dde0b71cbd8d533528 |
|
| MD5 | b0ce554d827f1abfea5f00ee3b2e56d7 |
|
| BLAKE2b-256 | c88b22dab9a36bf22cd297e06b731ef76568436d957b641d1134da5a9a4121ab |
File details
Details for the file airavata_django_portal_sdk-1.8.4-py3-none-any.whl.
File metadata
- Download URL: airavata_django_portal_sdk-1.8.4-py3-none-any.whl
- Upload date:
- Size: 50.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9e3d0be57a068ac57c8ebeb083dee4a5236865dc6e6c82b7c01d6e8db65d9b12 |
|
| MD5 | 96547d0fbbbed4eba9f5b3ade6ea6cda |
|
| BLAKE2b-256 | e220bb96f0ee486e9e42c41262e8758eb8c6cf0b823cfb61651f6333bf8bec17 |
