bcgov/wps

CFFDRS API: Hello World

Ouverte

#2 275 ouverte le 14 sept. 2022

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Python (10 forks)auto 404
4RefinementGood First IssueTask

Métriques du dépôt

Stars
 (65 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

Describe the task First baby step towards making our own CFFDRS API microservice.

Acceptance Criteria

  • Uses FastAPI to create an app that says "Hello world"
  • Deploys all the way through to prod with GH Actions
  • The project will have to be licensed as GPL to comply with the CFFDRS license.
  • Using a familiar stack with poetry + python + fastapi

Additional context

  • Stick with our existing stack for now because it's familiar
  • In anticipation of using Python implementation in CFF API instead of R package

Guide contributeur

Direction de recherche
Explorez la structure du dépôt existant pour trouver des microservices similaires et comprenez les modèles de configuration, de test et de déploiement FastAPI utilisés dans GitHub Actions. Identifiez comment les autres services sont licenciés et configurés, puis créez une application FastAPI minimale en suivant ces conventions.
Stack technique
pythonfastapi
Domaine
backendapi
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPythonPoetry
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80