commit | c387158f57a0bbb5c5708647975bb0d7b0c949a2 | [log] [tgz] |
---|---|---|
author | Marcus Christie <machrist@iu.edu> | Tue Oct 06 15:28:19 2020 -0400 |
committer | Marcus Christie <machrist@iu.edu> | Tue Oct 06 15:28:19 2020 -0400 |
tree | 138b3d60ab9e97e66584779970b9c0d17014b807 | |
parent | ff2b662cf125a3425be3f540c5ccfddf38515934 [diff] |
updating getting started notes
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.
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
django-admin makemigrations --settings=tests.test_settings airavata_django_portal_sdk
To generate the documentation, create a virtual environment and then:
pip install -r requirements-dev.txt mkdocs serve