Commit 87c04d21 authored by Mickaël Desfrênes's avatar Mickaël Desfrênes
Browse files

pypi stuff

parent 24afa43a

.env-dist

deleted100644 → 0
+0 −31
Original line number Diff line number Diff line 
CACHE_LOCATION="var/cache"

JAMA_APPS=""

JAMA_ARK_APP_ID=""

JAMA_ARK_SECRET_KEY=""

JAMA_ARK_SERVER=""

JAMA_DB_ADAPTER="sqlite"

JAMA_DB_HOST="localhost"

JAMA_DB_NAME="django"

JAMA_DB_PASSWORD="django"

JAMA_DB_PORT="5432"

JAMA_DB_USER="django"

JAMA_DEBUG="0"

JAMA_FILES_DIR="var/media_sources_files"

JAMA_IIIF_DIR="var/iiif"

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

JAMA_IIIF_PROCESSING_DIR="var/processing"

JAMA_IIIF_UPSCALING_PREFIX="^"

JAMA_LOG_FILE="var/jama.log"

JAMA_PARTIAL_UPLOADS_DIR="var/partial_uploads"

JAMA_SECRET="Vas5xetqnK4P7wYJcgGFyh"

JAMA_SITE="http://localhost:8000/"

JAMA_SQLITE_DB_PATH="var/db.sqlite3"

JAMA_URL_BASE_PATH=""

JAMA_USE_ARK="0"

JAMA_USE_CACHALOT="0"

JAMA_USE_MODSHIB="#"

JAMA_USE_OAI="0"

JAMA_USE_WEBP="0"

MODSHIB_SHOW_LOCAL_LOGIN="1"

MODSHIB_SHOW_SSO_LOGIN="0"

VAR_DIR="var"
 
 No newline at end of file

README.md

+0 −5
Original line number Diff line number Diff line
@@ -9,11 +9,6 @@ APIs et interfaces de stockage de médias. 
- pdftoppm, pdftotext (poppler-utils)

- vips (libvips-tools)

- tesseract



Optionnel:



- PostgreSQL >= 11

- une base de donnée PostgreSQL vide et un utilisateur ayant tous les droits dessus

- exiftool



## Installation

pypi.md

0 → 100644
+45 −0
Original line number Diff line number Diff line 
# Jama



Jama is a [Django](https://www.djangoproject.com/) application that exposes APIs and UIs that allow users to organize collections of resources.



Knowledge of the Django framework is expected and the Jama documentation is, to put it midly, a work in progress.



## Install



    pip install jama-CERTIC



## Usage



Jama behaves like a normal Django app except the management script is not called `manage.py` but `jama`.



List of commands:



    jama --help



Upon first run, Jama creates a `$HOME/.jama/` directory where it stores all its data.



Development server:



    jama runserver



Background tasks:



    jama run_huey



## Configuration



Configuration can be changed by adding environment variables the usual way or by adding them to your

`$HOME/.jama/env` configuration file



Available variables:



    JAMA_DEBUG="0"

    JAMA_APPS="ui"

    JAMA_IIIF_ENDPOINT="http://localhost/iip/IIIF="  # base URL for the IIIF server (use IIP server or Cantaloupe)

    JAMA_IIIF_UPSCALING_PREFIX="^"

    JAMA_SECRET="7d*_8c!d$vv963qpr45_x)@f2t-x6fu2&yi+m+d6s!p!lt+_j+"

    JAMA_SITE="http://localhost:8000/"

    JAMA_STATIC_ROOT="var/static"  # where to put files when using "jama collectstatic"

    JAMA_USE_MODSHIB="1"

    MODSHIB_SHOW_LOCAL_LOGIN="1"

    MODSHIB_SHOW_SSO_LOGIN="0"

pyproject.toml

+25 −10
Original line number Diff line number Diff line 
[project]

name = "jama"

name = "jama-CERTIC"

dynamic = ["version"]

description = "APIs et interfaces de stockage de médias."

readme = "README.md"

readme = "pypi.md"

requires-python = ">=3.12,<4.0"

license = "CeCILL-B"

license-files = ["LICENSE.txt"]
@@ -38,32 +38,47 @@ dependencies = [ 
    "Unidecode>=1.3.4",

]





authors = [

    { name = "Mickaël Desfrênes", email = "mickael.desfrenes@unicaen.fr" }

    { name = "Mickaël Desfrênes", email = "mickael.desfrenes@unicaen.fr" },

]

maintainers = [

    { name = "Mickaël Desfrênes", email = "mickael.desfrenes@unicaen.fr" }

    { name = "Mickaël Desfrênes", email = "mickael.desfrenes@unicaen.fr" },

]



[dependency-groups]

dev = [

    "ruff>=0.9.2",

    "pre-commit>=4.1.0",

]

dev = ["ruff>=0.9.2", "pre-commit>=4.1.0"]



[project.scripts]

jama = 'jama.__main__:run'



[project.urls]

Repository = "https://git.unicaen.fr/certic/jama"





[build-system]

requires = ["hatchling"]

build-backend = "hatchling.build"



[tool.hatch.build.targets.wheel]

packages = ["src/jama", "src/annotations", "src/oai", "src/resources", "src/rpc", "src/ui"]

packages = [

    "src/jama",

    "src/annotations",

    "src/oai",

    "src/resources",

    "src/rpc",

    "src/ui",

]



[tool.hatch.build.targets.src]

packages = ["src/jama", "src/annotations", "src/oai", "src/resources", "src/rpc", "src/ui"]

packages = [

    "src/jama",

    "src/annotations",

    "src/oai",

    "src/resources",

    "src/rpc",

    "src/ui",

]



[tool.hatch.metadata]

allow-direct-references = true

src/jama/__main__.py

+4 −0
Original line number Diff line number Diff line
@@ -13,3 +13,7 @@ def run(): 
            "forget to activate a virtual environment?"

        ) from exc

    execute_from_command_line(sys.argv)





if __name__ == "__main__":

    run()