The Airavata Django Portal SDK is a library that makes it easier to develop Airavata Django Portal customizations.
Project description
# Airavata Django Portal SDK
[](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/* `
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.2.dev1.tar.gz.
File metadata
- Download URL: airavata-django-portal-sdk-1.2.dev1.tar.gz
- Upload date:
- Size: 33.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ae5c4ec6b66698cdb5e56848eaded7a64f8fdccf8299c7012688a5c9b487ceae |
|
| MD5 | 9d7e168da8b296471fee0b9ee318c6a7 |
|
| BLAKE2b-256 | d5d1cfc50190407b59d8fb0f418d62f44fcc0d695526574843701f5c9c28612c |
File details
Details for the file airavata_django_portal_sdk-1.2.dev1-py3-none-any.whl.
File metadata
- Download URL: airavata_django_portal_sdk-1.2.dev1-py3-none-any.whl
- Upload date:
- Size: 39.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 71c4354e4cf76100c3e259b6b5f1f16b4145fb0d4b11fc81f56633ad2e3bbffd |
|
| MD5 | 2e4296a62ec46a20de64ca180c82e542 |
|
| BLAKE2b-256 | 328555beb3ac4d8bc51f7dc640343a75d3c42aa55dbaccc29fcdda0268d58fbc |
](https://travis-ci.com/apache/airavata-django-portal-sdk){kind=link}