Skip to content

Conversation

githubofkrishnadhas
Copy link
Contributor

This project is a FastAPI-based Python application that allows users to submit their name and favorite color, with endpoints to retrieve the submitted data. It includes features like logging with JSON formatting, in-memory storage for demonstration purposes, and automated dependency management using Dependabot.

Key Features

API Endpoints:

  • GET /: Root endpoint with a welcome message.
  • GET /healthcheck: Healthcheck endpoint to verify service status.
  • POST /usercolour/: Accepts a user's name and favorite color.
  • GET /allusercolour/: Lists all submitted user-color mappings.

Logging:

Configured using python-json-logger for JSON-formatted logs.
Logs are set up for the application and Uvicorn server.

Dependency Management:

Uses Poetry for managing dependencies and packaging.

  • Automated updates are configured via Dependabot.

Release Workflow:

A GitHub Actions workflow (release.yml) automates release creation when pull requests are merged into the main branch.
Dockerized Deployment:

Includes a [Dockerfile] for containerized deployment using Python 3.11

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant