Git Product home page Git Product logo

flask-api-sceleton's Introduction

Python Python 3.6 Maintenance

Flask API Sceleton for a simple REST API

Installation

Create the virtual environment

python3 -m venv venv

Activate the virtual environment

Windows

venv\Scripts\activate

Linux

source venv/bin/activate

Install the requirements

pip install -r requirements.txt

Run the application

python3 main.py

Run the tests

pytest -v -k webtest 

Understanding the project structure

The skeleton project structure adheres to a well-organized and modular design, fostering scalability and ease of maintenance in Python development. The main directories include:

  • api: Manages the project's API functionality, with version-specific subdirectories (v1) and modules (users_ops).

  • app_manager: Handles application setup and initialization, containing modules such as app_setup.

  • helpers: Contains utility functions and helper modules. We follow naming conventions such as ending files with _{first letter of developer name} for better in-team communication.

  • main.py: The primary file for initiating the project.

  • tests: Reserved for testing purposes.

  • Configuration files such as pytest.ini and requirements.txt are present at the root. This structured approach enhances code readability, separates concerns, and facilitates collaborative development, enabling contributors to comprehend and extend the project effortlessly.

Disclaimer

  • This project is for educational purposes only.
  • This project is not intended to be used in production as is.
  • This project is not intended to be used in production without proper security review.
  • This project is not intended to be used in production without proper testing.
  • Some docs generated with Github Copilot :)

flask-api-sceleton's People

Contributors

tsartsaris avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.