Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/aphp/federation-api

https://github.com/aphp/federation-api

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (5.4%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: aphp
  • Language: Python
  • Default Branch: main
  • Size: 104 KB
Statistics
  • Stars: 0
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme

README.md

image image Quality Gate Status Coverage

Federation API

Stack technique

Setup

1. 🎨 Récupérer le projet

sh git clone https://github.com/aphp/federation-api.git

2. 🚀 Lancer le projet

Avec Docker 🐋

  • Créer le fichier de variables d'environnement federation-api/.env à base du template .env.example

sh cd federation-api docker compose --env-file .docker.env up

  • Accéder à la documentation de l'API sur localhost:8000/docs
  • S'authentifier avec admin/1234 pour tester les routes de l'API

Avec Uvicorn 🦄

Avec Python 3.12 déjà installé, procéder comme suit:

  • Installer UV et créer un environnement virtuel

    sh cd federation-api pip install uv && uv venv py312venv && uv pip install --no-cache -r requirements.txt

  • Créer le fichier de variables d'environnement federation-api/.env à base du template .env.example

  • Démarrer Uvicorn sh source py312venv/bin/activate (py312venv) uvicorn platform_registry.main:app --port 8000 --reload

  • Accéder à la documentation de l'API sur localhost:8000/docs

  • Pour tester l'API:

    1. configurer un serveur de BD PotgreSQL et lancer les migrations avec Alembic sh (py312venv) alembic upgrade head
    2. Lancer le script pour créer un utilisateur initial admin sh (py312venv) python platform_registry/initial_data.py
    3. S'authentifier avec admin/1234 pour tester les routes de l'API

Owner

  • Name: Greater Paris University Hospitals (AP-HP)
  • Login: aphp
  • Kind: organization
  • Location: Paris

GitHub Events

Total
  • Delete event: 3
  • Push event: 4
  • Pull request event: 6
  • Create event: 3
Last Year
  • Delete event: 3
  • Push event: 4
  • Pull request event: 6
  • Create event: 3

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 minute
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 0
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 minute
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 3
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (6)
Top Labels
Issue Labels
Pull Request Labels
dependencies (6)

Dependencies

.github/workflows/main.yml actions
  • SonarSource/sonarcloud-github-action master composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • docker/build-push-action v4 composite
  • docker/login-action v2 composite
  • docker/setup-buildx-action v2 composite
Dockerfile docker
  • ${IMAGE_FROM} latest build
docker-compose.yml docker
  • postgres 14
requirements.txt pypi
  • Werkzeug ==3.0.3
  • alembic ==1.13.2
  • bcrypt ==3.2.2
  • coverage ==7.6.0
  • fastapi ==0.112.1
  • httpx ==0.27.0
  • kubernetes ==24.2.0
  • passlib ==1.7.4
  • psycopg ==3.2.1
  • pydantic >=2.7.0
  • pydantic-settings ==2.3.4
  • pyjwt ==2.8.0
  • pytest ==8.3.1
  • python-dateutil ==2.8.2
  • python-dotenv ==1.0.1
  • python-jose ==3.3.0
  • python-multipart ==0.0.9
  • pytz ==2022.1
  • requests ==2.32.3
  • sqlalchemy ==2.0.27
  • starlette ==0.38.2
  • uvicorn ==0.27.1