Python Flask REST API

A simple and scalable REST API built with Flask, designed for handling CRUD operations on a sample resource.

Table of Contents

• Project Description
• Features
• Installation
• Usage
• API Endpoints
• Running Tests
• Contributing
• License

Project Description

This project is a RESTful API implemented using the Flask framework. It provides endpoints for creating, reading, updating, and deleting resources.

The project aims to demonstrate and emulate best practices in API development, including proper routing, error handling, and documentation.

Features

• CRUD operations on a sample resource
• Input validation and error handling
• Token-based authentication (JWT)
• API documentation with OpenAPI
• Unit and integration tests

Installation

Prerequisites

• Python 3.8+
• pip package manager

Steps

1. Clone the repository:

   git clone https://github.com/jmodeorain14/python-flask-rest-api.git
   cd python-flask-rest-api

2. Create a virtual environment:

   python3 -m venv .venv
   source .venv/bin/activate   # On Windows use `.venv\Scripts\activate`

3. Install dependencies

   pip install -r requirements.txt

4. Run the application

   flask run

Usage

Running the API

After installation, you can start the API server using:

flask run

By default, the server will run on http://127.0.0.1:5000.

API Endpoints

To be completed by [@jmodeorain14]

Example Requests

To be completed by [@jmodeorain14]

Running Tests

To be completed by [@jmodeorain14]

Contributing

This is a personal project, however, I welcome contributions from the community.

To contribute:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Commit your changes with descriptive messages.
4. Push your branch to your fork.
5. Open a pull request to the main repository.

Please ensure you follow the Conventional Commits standard for commit messages.

License

This project is licensed under the MIT License. See the LICENSE file for more details.