https://github.com/devsecblueprint/azure-python-fastapi
https://github.com/devsecblueprint/azure-python-fastapi
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devsecblueprint/azure-python-fastapi
- Owner: devsecblueprint
- License: mit
- Created: 2025-08-20T04:05:12.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-26T22:23:13.000Z (9 months ago)
- Last Synced: 2025-08-27T03:05:01.983Z (9 months ago)
- Language: Python
- Size: 19.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Python FastAPI
This project sets up a simple FastAPI application (with some vulnerabilites) within a Docker container. It uses the official Python runtime and includes all necessary configurations to deploy a FastAPI app with Docker. The container will expose the app on port 80 and automatically run the FastAPI app on startup.
## Requirements
- Docker
- Python 3.12+
- FastAPI
- Uvicorn
## Features
- **Dockerized FastAPI application**: A containerized setup for easy deployment.
- **Python 3.12.5 runtime**: Uses the latest stable Python version as a base.
- **Efficient package installation**: Installs required dependencies via `requirements.txt`.
## Project Structure
```bash
gcp-python-fastapi/
├── Dockerfile
├── requirements.txt
├── main.py # FastAPI app entry point
└── ...
```
- **Dockerfile**: Configures the Docker container for the FastAPI app.
- **requirements.txt**: Specifies the required Python dependencies for the application.
- **main.py**: The entry point for the FastAPI application (Make sure to include this file in the project structure).
## Setup and Installation
### 1. Clone the repository
If you haven't cloned the project yet, use the following command:
```bash
git clone https://github.com/your-username/python-fastapi.git
cd python-fastapi
```
### 2. Build the Docker image
To build the Docker image, run the following command in the root of the project directory:
```bash
docker build -t python-fastapi .
```
### 3. Run the Docker container
After the image is built, run the container:
```bash
docker run -d -p 80:80 python-fastapi
```
This command will run the FastAPI app on port 80 of your localhost.
### 4. Access the app
Once the container is running, you can access the FastAPI application by navigating to:
```
http://localhost:80
```
## Dependencies
The project uses the following Python packages, which are listed in the `requirements.txt` file:
- `fastapi`: The core framework for building the API.
- `uvicorn`: ASGI server to run the FastAPI application.
To install dependencies locally, use the following:
```bash
pip install -r requirements.txt
```
## Notes
- This setup assumes that your FastAPI app’s entry point is `main.py`, and the FastAPI application instance is named `app`. If your app is structured differently, you may need to modify the `CMD` directive in the Dockerfile accordingly.
- The container will expose the application on port 80. If you want to use a different port, adjust the `EXPOSE` and `CMD` directives in the Dockerfile.