Commit 4c3988ba authored by Mickaël Desfrênes's avatar Mickaël Desfrênes
Browse files

add doc

parent 7dd88165

README.md

+7 −0
Original line number Diff line number Diff line
@@ -25,6 +25,7 @@ APIs et interfaces de stockage de médias. 
    export JAMA_IIIF_DIR=""

    export JAMA_FILES_DIR=""

    export JAMA_IIIF_ENDPOINT="http://localhost/iip/IIIF="

    export JAMA_APPS=""



> _Astuce_ : créer un fichier `.env` à la racine du projet avec l'ensemble des variables déclarées

```bash
@@ -154,3 +155,9 @@ Les enregistrements retournés correspondent aux collections Jama pour lesquelle 
    >>> key, _ = APIKey.objects.get_or_create(user=test_user, key="123456")

    >>> key.active = True

    >>> key.save()



## Applications "plugin"



JAMA_APPS peut contenir une liste de modules python à charger en tant qu'application

Django. Si `[module].endpoint` est défini, alors `endpoint` est utilisé comme point de

montage pour les urls définies dans l'application.
 
 No newline at end of file

jama/urls.py

+9 −5
Original line number Diff line number Diff line
@@ -24,9 +24,13 @@ urlpatterns = [ 
]



for app in settings.AUTO_REGISTER_APPS:

    module = __import__(app)

    try:

        urlpatterns.append(

            path(

            settings.JAMA_URL_BASE_PATH + getattr(__import__(app), "endpoint"),

                settings.JAMA_URL_BASE_PATH + getattr(module, "endpoint"),

                include("{}.urls".format(app)),

            )

        )

    except AttributeError:

        continue