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.127.tar.gz (27.9 kB view details)

Uploaded Source

Built Distribution

msabase-0.0.127-py3-none-any.whl (30.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for msabase-0.0.127.tar.gz
Algorithm Hash digest
SHA256 43630ab4f7d9b4506dd42dcf94713e8b78bbc3a0a4ed6624ed8d5420f44493cd
MD5 9054f54a59867c484c663c92080ffa2f
BLAKE2b-256 cb40055ed8ab036b9724dee3353dd4afbc95fec876c657f71f26e14a6c1258af

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for msabase-0.0.127-py3-none-any.whl
Algorithm Hash digest
SHA256 c9503bc451eb3e9db5d99382103e1c60885a7768f3ab185c1edd7a5812540e61
MD5 bdff1a9e20d68273ee442ea2cd4e2c60
BLAKE2b-256 06ea6cba85ffc39b00deb84893e55741dcf7ee845e759d7fe65203d6d9a23fb6

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