Quick Start

Install

Install from GitHub:

$ pip install git+https://github.com/UW-GAC/django-anvil-consortium-manager.git

Configure

You will need a service account credentials file that is registered with Terra. See the Terra service account documentation for more information.

Required Settings

  1. Add required apps and anvil_consortium_manager to your INSTALLED_APPS setting.

INSTALLED_APPS = [
    # The following apps are required:
    "django.contrib.messages",
    "django.contrib.sites",
    "django-tables2",

    # This app:
    "anvil_consortium_manager",
]

  1. Set the ANVIL_API_SERVICE_ACCOUNT_FILE setting to the path to the service account credentials file.

ANVIL_API_SERVICE_ACCOUNT_FILE="/<path>/<to>/<service_account>.json"

Alternatively, if you would like to browse the app without making any API, just set this to a random string (e.g., "foo").

  1. Set the default account and workspace adapters in your settings file.

ANVIL_WORKSPACE_ADAPTERS = ["anvil_consortium_manager.adapters.default.DefaultWorkspaceAdapter"]
ANVIL_ACCOUNT_ADAPTER = "anvil_consortium_manager.adapters.default.DefaultAccountAdapter"

See the Advanced Usage section for information about customizing Accounts and Workspaces. Note that you can have multiple Workspace adapters, but only one Account adapter.

  1. Add account linking settings to your settings file.

# Specify the URL name that AccountLink and AccountLinkVerify redirect to.
ANVIL_ACCOUNT_LINK_REDIRECT = "home"
# Specify the subject for AnVIL account verification emails.
ANVIL_ACCOUNT_LINK_EMAIL_SUBJECT = "Verify your AnVIL account email"

  1. Set up a Site in the sites framework. In your settings file:

SITE_ID = 1

Optional settings

If you would like to receive emails when a user links their account, set the ANVIL_ACCOUNT_VERIFY_NOTIFICATION_EMAIL setting in your settings file.

ANVIL_ACCOUNT_VERIFY_NOTIFICATION_EMAIL = "to@example.com"

Post-installation

  1. In your Django root directory, execute the command below to create your database tables:

python manage.py migrate

  1. Start your server and add a site for your domain using the admin interface (e.g. http://localhost:8000/admin/). Make sure settings.SITE_ID matches the ID for this site.

Permissions

The app provides four different permissions settings.

  1. anvil_project_manager_edit - users with this permission can add, delete, or edit models, for example import an account from AnVIL or create a workspace.

  2. anvil_project_manager_view - users with this permission can view information, for example lists of users or workspace details.

  3. anvil_project_manager_account_link - users with this permission can link their AnVIL accounts in the app using the AccountLink and AccountLinkVerify views.

  4. anvil_project_manager_limited_view - in the future, this permission will be used to allow users to view a limited set of information within the site. Rigt now, it is not used by the app.

We suggest creating three groups, viewers (with anvil_project_manager_view permission), editors (with both anvil_project_manager_view and anvil_project_manager_edit permission), and a final group for users who are allowed to link their AnVIL account. Users can then be added to the appropriate group. Note that users with edit permission but not view permission will not be able to see lists or detail pages, so anyone granted edit permission should also be granted view permission.