DuckDB-SPAWN Data Product

A data product API for project financing using DuckDB, FastAPI, and Prometheus monitoring.

Table of Contents

• Features
• Local Development
• Koyeb Deployment
• Monitoring
• Project Structure
• Contributing
• License
• Contact
• Citations

Features

• FastAPI-based REST API
• DuckDB for data storage
• Prometheus metrics collection
• Project financing data model
• Environment-based configuration

Local Development

1. Set up the environment: Ensure you have Docker installed and running on your machine.

2. Build the Docker image:

   docker build -t your-image-name .

3. Run the Docker container:

   docker run -p 8000:8000 your-image-name

4. Access the application: Open your browser and go to http://localhost:8000.

Koyeb Deployment

Instructions to deploy the application on Koyeb.

This project is using koyeb-git-action to deploy the application.

Monitoring

Details on how to monitor the application using Prometheus.

Project Structure

Overview of the project's directory structure and files.

Contributing

Guidelines for contributing to the project.

1. Fork the repository
2. Create a new branch (git checkout -b feature/your-feature)
3. Commit your changes (git commit -m 'Add some feature')
4. Push to the branch (git push origin feature/your-feature)
5. Open a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

Your Name - jeanbapt

Project Link: https://github.com/jeanbapt/duckdb-spawn

Citations

This project utilizes the following technologies:

• FastAPI: A modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
• DuckDB: An in-process SQL OLAP database management system.
• Prometheus: An open-source systems monitoring and alerting toolkit.
• Koyeb: A platform for deploying and running applications in the cloud.
• Pulumi: A modern infrastructure as code platform that allows you to define cloud resources using programming languages.