pyfost.gestion-studio 0.1.5

Studio Seat Management Tools

⚠️ Not Production Ready ⚠️

pyfost.gestion_studio

Fost Studio Seats Management Tools

Table of Contents

• Installation
• Run
• Dev
• License

Installation

Create a virualenv, activate it, and then:

pip install pyfost.gestion-studio

Run

Services

Edit a .env or .env.DEV or .env.PROD file (Use the .env in the repo root as example). Then, in the same folder, spawn your services:

• Full Stack: python -m pyfost.gestion_studio.main_all
• All Backends: python -m pyfost.gestion_studio.main_backends
• All Frontends: python -m pyfost.gestion_studio.main_frontends

Python APIs

You can interact with the services using their respecive clients:

from pyfost.gestion_studio.floors.api import FloorsAPI
from pyfost.gestion_studio.projects.api import ProjectsAPI

floors_api = ProjectsAPI(host=<floors_service_host>, port=<floors_service_port>)
facilities = floors_api.get_facilities()

project_api = ProjectsAPI(host=<project_service_host>, port=<project_service_port>)
tasks = projects_api.get_tasks()

Dev

Tips

• You can explore the content of the sqlite files (*.db in the repo root) using:
  • https://inloop.github.io/sqlite-viewer/
  • https://sqliteviewer.app/
  • my fav: https://beta.sqliteviewer.app/
  • or download sqlitebrowser here: https://sqlitebrowser.org/
• You can copy/past svg from web editors to create map symbols:
  • https://boxy-svg.com/

floors

(! OUTDATED !)

• To generate the python client from the backend (api)
  • run the backend standalone: fastapi run src/pyfost/gestion_studio/floors/backend/main.py
  • install openapi-python-client: pipx install openapi-python-client --include-deps
  • cd to the root of the repo (containing this file)
  • generate the client: openapi-python-client generate --url http://127.0.0.1:8000/openapi.json --output-path ../pyfost.gestion-studio-floors_api --config openapi-python-client.yaml
  • replace current client (./src/pyfost/gestion_studio/floors/api) by the generated one (../pyfost.gestion-studio-floors_api/api)
  • also copy the client README (../pyfost.gestion-studio-floors_api/README.md -> ./src/pyfost/gestion_studio/floors/api/README.md)

License

pyfost.gestion-studio is distributed under the terms of the GNU GPL-3.0 or later license.