Expanding the main api

This page describes how to expand the API of the main repository (BB8-2020/main)

If you were looking to expand your use-case's API please have a look at Expanding a use-case's API

This page only applies to Technical Leads since other people can't edit the main repository

To add a new API / Use Case

In requirements.txt

Please add the following as a new line to the file:

-e git+<github_url>#egg=<package_name>

The package_name can be found in <repo>/setup.py

In main.py

Please add the following:

# Please add your import
from <repo_name>.urls import urls as <repo_name>_urls

...

def setup_urls():
    new_urls = [
        ...,
        # Add your URL definition
        *<repo_name>_urls
    ]

    ...