pamelafox / simple-fastapi-container

A simple FastAPI app that is containerized and designed for development on Azure Container Apps.

This repository includes a simple Python FastAPI app with a single route that returns JSON. You can use this project as a starting point for your own APIs.

The repository is designed for use with Docker containers, both for local development and deployment, and includes infrastructure files for deployment to Azure Container Apps. 🐳

The code istested with pytest, linted with ruff, and formatted with black. Code quality issues are all checked with both pre-commit and Github actions.

Opening the project

This project has Dev Container support, so it will be be setup automatically if you open it in Github Codespaces or in local VS Code with the Dev Containers extension.

If you're not using one of those options for opening the project, then you'll need to:

1. Create a Python virtual environment and activate it.

2. Install the requirements:

   python3 -m pip install -r requirements-dev.txt

3. Install the pre-commit hooks:

   pre-commit install

Local development

1. Run the local server:

   uvicorn src.api.main:app --port 3100 --reload

2. Click 'http://127.0.0.1:3100' in the terminal, which should open a new tab in the browser.

3. Try the API at '/generate_name' and try passing in a parameter at the end of the URL, like '/generate_name?starts_with=N'.

Local development with Docker

You can also run this app with Docker, thanks to the Dockerfile.

You need to either have Docker Desktop installed or have this open in Github Codespaces for these commands to work. ⚠️ If you're on an Apple M1/M2, you won't be able to run docker commands inside a Dev Container; either use Codespaces or do not open the Dev Container.

1. Build the image:

   docker build --tag fastapi-app ./src
   

2. Run the image:

   docker run --publish 3100:3100 fastapi-app
   

Deployment

This repo is set up for deployment on Azure Container Apps using the configuration files in the infra folder.

This diagram shows the architecture of the deployment:

Steps for deployment:

1. Sign up for a free Azure account and create an Azure Subscription.

2. Install the Azure Developer CLI. (If you open this repository in Codespaces or with the VS Code Dev Containers extension, that part will be done for you.)

3. Login to Azure:

   azd auth login

4. Provision and deploy all the resources:

   azd up

   It will prompt you to provide an azd environment name (like "fastapi-app"), select a subscription from your Azure account, and select a location (like "eastus"). Then it will provision the resources in your account and deploy the latest code. If you get an error with deployment, changing the location can help, as there may be availability constraints for some of the resources.

5. When azd has finished deploying, you'll see an endpoint URI in the command output. Visit that URI, and you should see the API output! 🎉

6. When you've made any changes to the app code, you can just run:

   azd deploy

Costs

Pricing varies per region and usage, so it isn't possible to predict exact costs for your usage. The majority of the Azure resources used in this infrastructure are on usage-based pricing tiers. However, Azure Container Registry has a fixed cost per registry per day.

You can try the Azure pricing calculator for the resources:

• Azure Container App: Consumption tier with 0.5 CPU, 1GiB memory/storage. Pricing is based on resource allocation, and each month allows for a certain amount of free usage. Pricing
• Azure Container Registry: Basic tier. Pricing
• Log analytics: Pay-as-you-go tier. Costs based on data ingested. Pricing

⚠️ To avoid unnecessary costs, remember to take down your app if it's no longer in use, either by deleting the resource group in the Portal or running azd down.

Getting help

If you're working with this project and running into issues, please post in Discussions.

simple-fastapi-container's Issues

Updating/work-with this template for GHA feature.

We are updating this template to support new features in Github Action.

For the Github Action feature: We will remove two lines of code on container image and add GHA code after checkout step in the .github/workflow/azure-dev.yml file. (Shown as below)

@rajeshkamal5050 , @pamelafox for notification.

Container start fails

When using the container version, within Visual Studio code in MAC M2, the following error shows:

An error has occurred: FatalError: git failed. Is it installed, and are you in a Git repository directory? Check the log at /home/vscode/.cache/pre-commit/pre-commit.log [18551 ms] postCreateCommand failed with exit code 1. Skipping any further user-provided commands.

README issues

Describe the issue:
The port is incorrect.

Suggestion: Update to 3100.

Describe the issue:
failed to read dockerfile error occurs when execute the command below, for the Dockerfile is actually in the src folder.

Suggestion:
Add a step cd src, or update the command to docker build --tag fastapi-app .\src .

Describe the issue:
Miss the option --template .

Suggestion:
Please provide the --template option, update to azd init --template pamelafox/simple-fastapi-container

@pamelafox for notification.