░▒▓███████▓▒░░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░▒▓████████▓▒░
░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░  ░▒▓█▓▒░
░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░  ░▒▓█▓▒░
░▒▓███████▓▒░ ░▒▓██████▓▒░       ░▒▓███████▓▒░░▒▓█▓▒░  ░▒▓█▓▒░
░▒▓█▓▒░         ░▒▓█▓▒░          ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░  ░▒▓█▓▒░
░▒▓█▓▒░         ░▒▓█▓▒░          ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░  ░▒▓█▓▒░
░▒▓█▓▒░         ░▒▓█▓▒░          ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░  ░▒▓█▓▒░

Description

Py-kit repo serves as a reference for initializing a Python server for backend development. It follows clean architecture to ensure maintainability and scalability.

Features

• User management
• FastAPI for building APIs
• Pydantic for data validation
• PostgreSQL database integration
• USe Alembic for migrations
• SQLAlchemy for ORM

Prerequisites

• Docker
• Docker Compose

Installation

1. Clone the repository:

   git clone https://github.com/perfectbuii/pykit.git
   cd pykit

2. Create a [.env] file in the root directory and add the following environment variables:

   POSTGRES_USER=your_postgres_user
   POSTGRES_PASSWORD=your_postgres_password
   POSTGRES_DB=your_postgres_db
   ENV=docker

Running the Application

1. Build and start the application using Docker Compose:

   docker-compose down --rmi all && docker-compose up --build --force-recreate

2. The application will be available at [http://localhost:8000].

API Endpoints

• [POST /api/user/] - Create a new user

Testing the API

You can test the API by navigating to [http://localhost:8000/docs] in your web browser. This will open the interactive API documentation provided by FastAPI, where you can run and test the API endpoints directly.