Skip to main content

General Package for Microservices based on FastAPI like Profiler, Scheduler, Sysinfo, Healtcheck, Error Handling etc.

Project description

msaBase
</p>
<hr />
<p align= msaBase- General Package for Microservices based on FastAPI like Profiler, Scheduler, Sysinfo, Healtcheck, Error Handling etc.
Optimized for use with FastAPI/Pydantic.
Package version Supported Python versions


Documentation: Documentation (https://msaBase.u2d.ai/)


Features

  • MSABaseExceptionHandler: Central exception handler which sends formatted exception to logger
  • Filehandler utilities: Classes for FileDelete, FileUpload async with chunking, Archive pack/unpack formats, helper functions
  • mkdocs code reference helper: Create virtual mkdocs navs for code reference and used libraries from requirements.txt
  • MSAHealthCheck: Healthcheck class with internal own thread, which checks url for health
  • logger intercept handler: allows to change handler from all logger and define specific output format with loguru
  • Models for files and health classes: reusable pydantic models for file handling and dealing with healthcheck status
  • MSAProfilerMiddleware: PyInstrument Profiler as Middleware to create a html for an admin Dashboard
  • MSAAppSettings: API oriented settings class with environment vars and .env file support
  • Service oriented System Info: Classes and functions to get pydantic model response about system and gpu information

License Agreement

  • msaBaseBased on MIT open source and free to use, it is free for commercial use, but please show/list the copyright information about msaBase somewhere.

How to create the documentation

We use mkdocs and mkdocsstring. The code reference and nav entry get's created virtually by the triggered python script /docs/gen_ref_pages.py while mkdocs serve or build is executed.

Requirements Install for the PDF creation option:

PDF Export is using mainly weasyprint, if you get some errors here pls. check there documentation. Installation is part of the msaBase, so this should be fine.

We can now test and view our documentation using:

mkdocs serve

Build static Site:

mkdocs build

Build and Publish

Build:

python setup.py sdist

Publish to pypi:

twine upload dist/*

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

msabase-0.0.123.tar.gz (27.6 kB view details)

Uploaded Source

Built Distribution

msabase-0.0.123-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file msabase-0.0.123.tar.gz.

File metadata

  • Download URL: msabase-0.0.123.tar.gz
  • Upload date:
  • Size: 27.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.9.18 Linux/6.2.0-1015-azure

File hashes

Hashes for msabase-0.0.123.tar.gz
Algorithm Hash digest
SHA256 1b3f57dd2e05bf5298455f80496894ae1ba9aade1ce096a1b085ab78ce6f7a54
MD5 26a9089b17cf97cc7e146e2f68e2d9e4
BLAKE2b-256 ce6018138047fb7ffe93c19e0f9ec829958b7fbf576ab3e007a27a7c7812df44

See more details on using hashes here.

File details

Details for the file msabase-0.0.123-py3-none-any.whl.

File metadata

  • Download URL: msabase-0.0.123-py3-none-any.whl
  • Upload date:
  • Size: 30.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.9.18 Linux/6.2.0-1015-azure

File hashes

Hashes for msabase-0.0.123-py3-none-any.whl
Algorithm Hash digest
SHA256 4ab43203305255def84ebc3401c1dcf240af3983b56eb7f2ecfd4850046e9c56
MD5 eb0f93ba9c65d9999597ae70b3806d3a
BLAKE2b-256 1237e34cec72f99925fe956967c842c70cdb30e046adbce61119ddfffe9e852e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page