GauravKumarYadav/python_project_packaging

FastAPI Project

Description: This FastAPI project is designed to facilitate the insertion of data into a Hive table efficiently.

Table of Contents

• Overview
• Prerequisites
• Installation
• Usage
• Testing
• Contributing

Overview

FastAPI Project is a robust solution for inserting data into a Hive table. Leveraging FastAPI, a modern and high-performance web framework for building APIs, this project provides a seamless and efficient way to interact with Hive.

Prerequisites

Before you get started, ensure you have the following prerequisites:

• Python 3.8 or later: If not installed, download and install Python from python.org or through your package manager.

• Poetry: This project uses Poetry for managing dependencies. If you don't have Poetry installed, you can install it following the instructions here.

Installation

1. Clone the repository to your local machine:

   git clone https://github.com/GauravKumarYadav/python_project_packaging.git

2. Change to the project directory:

   cd fastapiproject

3. Install project dependencies using Poetry:

   poetry install

Usage

To run the FastAPI application, execute the following command:

poetry run uvicorn src.fastapiproject.app:app --host 0.0.0.0 --port 8000 --reload

You can access the API at http://localhost:8000. Make sure to modify the host and port as needed.

Testing

To run the tests, execute the following command:

poetry run pytest --cov=src tests/

Contributing

Contributions are welcome!