Welcome to Iperon documentation!

https://github.com/kostya-ten/iperon/actions/workflows/testing.yml/badge.svg?branch=main https://codecov.io/gh/kostya-ten/iperon/branch/main/graph/badge.svg?token=IAANLUR5LP https://app.codacy.com/project/badge/Grade/15e55045f9244aa99cf5e0162e93f80b https://img.shields.io/github/last-commit/kostya-ten/iperon/main Documentation Status https://img.shields.io/github/license/kostya-ten/iperon https://deepsource.io/gh/kostya-ten/iperon.svg/?label=active+issues&token=VXWJEyQ6M-Vkyv3XPNJSMb1H

General knowledge

The project is written in Python 3.10+

Here is the stack we are using

Name

Software

Language

Python 3.10+

Framework

FastAPI

Database

Postgres 14

ORM

Tortoise orm

Cache

Redis

Queue

Rabbit MQ

Project structure

Folder and file

Description

.github/

Github actions

.run/

Startup scripts app for Pycharm IDE

docker/

Docker files for API and Celery

docs/

Documentation source files for Sphinx-doc

iperon/

Project source files

iperon/commands/

Command files

iperon/contrib/

Supporting services and solutions

iperon/handlers/

Request handlers

iperon/services/

Business application logic

iperon/store/

Services for working with the DB or http request

iperon/templates/

HTML templates

iperon/cache.py

Working cache (redis)

iperon/depends.py

Inbound request handlers for functions

iperon/exceptions.py

Exception Handling

iperon/http_base_client.py

Base http client

iperon/logger.py

Logger

iperon/routes.py

Http Routes

iperon/tasks.py

Tasks for celery

iperon/typeof.py

Custom type object

tests/

Tests files

.editorconfig

See - https://editorconfig.org/

.flake8

Config linter flake8

.gitignore

gitignore file

.pre-commit-config.yaml

See - https://pre-commit.com/

.codecov.yml

See - https://codecov.io/

.env

Development settings

LICENSE

License agreement

MANIFEST.in

Manifest

mypy.ini

Mypy settings, detail - https://mypy.readthedocs.io/

README.rst

Default readme file

requirements.txt

Package dependency file

setup.py

Installation file

Docker service

Container

IP

ELK

10.0.0.60

Postgres

10.0.0.70

Redis

10.0.0.80

RabbitMQ

10.0.0.90

Contrib

Services

Handlers

Store