Python API Server for n8n automation scrips using Python and getting triggered by using HTTP-Requests

This is a simple FastAPI application that serves as a starting point for building web APIs.

Project Structure

py_api_for_n8n
├── app
│   ├── __init__.py
│   ├── main.py
│   ├── api
│   │   ├── __init__.py
│   │   └── routes.py
│   ├── models
│   │   ├── __init__.py
│   │   └── schemas.py
│   └── core
│       ├── __init__.py
│       └── config.py
├── requirements.txt
└── README.md

Installation

Option 1: Docker (Recommended)

The easiest way to run this application is using Docker:

# Quick start
./docker-start.sh  # Linux/Mac
# or
docker-start.bat   # Windows

# Or manually
docker-compose -f docker/docker-compose.yml up --build

See the Docker documentation for more details.

Option 2: Local Installation

To get started with this project locally, clone the repository and install the required dependencies:

git clone <repository-url>
cd py_api_for_n8n
pip install -r requirements.txt

Usage

Docker

# Start with Docker (recommended)
./docker-start.sh  # Linux/Mac
# or
docker-start.bat   # Windows

Local Development

# Run locally
uvicorn app.main:app --reload

Both methods will start the server at http://127.0.0.1:8000. You can access the interactive API documentation at http://127.0.0.1:8000/docs.

Contributing

Feel free to submit issues or pull requests if you have suggestions or improvements for the project.

License

This project is licensed under the MIT License.