The Airavata Custos Portal SDK is a library that makes it easier to develop Airavata Custos Portal customizations.
Project description
Airavata Custos Portal
How to use
Airavat custos portal is available as a python package to install and customise for tenants needs. The forllowing instructions are for setting up a customised portal using all the features available in the airavata custos portal.
- Install
pip install airavata-custos-portal
- Create a Django app
django-admin startproject my_first_custos_app
cd my_first_custos_app/my_first_custos_app
django-admin startapp my_custom_ui
- Include the custos portal api and frontend in the urls.
# my_first_custos_app/my_first_custos_app/urls.py
from django.contrib import admin
from django.urls import path
from django.conf.urls import include
urlpatterns = [
path('admin/', admin.site.urls),
path("api/", include("airavata_custos_portal.apps.api.urls")),
path("", include("airavata_custos_portal.apps.frontend.urls")),
]
- Also, include the custom UI app in the urls.
# my_first_custos_app/my_first_custos_app/urls.py
from django.contrib import admin
from django.urls import path
from django.conf.urls import include
urlpatterns = [
path('admin/', admin.site.urls),
path("api/", include("airavata_custos_portal.apps.api.urls")),
path("", include("airavata_custos_portal.apps.frontend.urls")),
path("custom-ui/", include("my_first_custos_app.my_custom_ui.urls")),
]
Development
The application consists of a Vue.js frontend and a Django based backend. The instructions below are for setting up the local setup for development.
Change the configurations
Change the environment variables on .env
Run Vue.js app
yarn install
yarn serve
Lints and fixes files
yarn lint
Running the Django server locally
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
cd airavata_custos_portal/
./manage.py migrate
./manage.py runserver
And then point to http://localhost:8000
How to publish
- Build the static files
yarn build
- Build the python package
python -m pip install --upgrade build
python -m build
- Publish the python package to pypi.org. Optionally can push to test.pypi.org. See https://packaging.python.org/tutorials/packaging-projects/ for more info.
python -m pip install --upgrade twine
python -m twine upload dist/*
Project details
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_custos_portal-0.0.6.tar.gz
.
File metadata
- Download URL: airavata_custos_portal-0.0.6.tar.gz
- Upload date:
- Size: 1.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84bdaab55edc12ab0d64c3d8152142a65c4d373ab6e777d845b42c3077b29ff3 |
|
MD5 | 6d35143eba058a5e12d440d8013362ec |
|
BLAKE2b-256 | b8176c1615616e2b5043f2112ec2e7431b3b337c6a28223c3eee30d00bf99358 |
File details
Details for the file airavata_custos_portal-0.0.6-py3-none-any.whl
.
File metadata
- Download URL: airavata_custos_portal-0.0.6-py3-none-any.whl
- Upload date:
- Size: 1.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc3b1dac9b8a736c2f63ab41e53adcee2595b96e704de8adaa07b3efdbe86260 |
|
MD5 | 7e4c93a3658446c043c83fd78cc1b346 |
|
BLAKE2b-256 | b08f3211c18203b717f2d53695e17de5daf171eac7d9415c6bfbe9bb66c95fd2 |