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

Uploaded Source

Built Distribution

msabase-0.0.121-py3-none-any.whl (29.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for msabase-0.0.121.tar.gz
Algorithm Hash digest
SHA256 693f01add38d8088108266b5075c6ecbe894391c1a0b98100bc302b5f09bd141
MD5 2b9ddd6b0240368325a939e39bf69ee5
BLAKE2b-256 85b8c54590b22c03da943de16d35f7807f5430fdf67bc65b3097ec824ed69a23

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for msabase-0.0.121-py3-none-any.whl
Algorithm Hash digest
SHA256 5c4fd1bc3b6e5b9effec0d2ca57a77590563962dd608af6e81f630795e8d7c0a
MD5 1c463eff38257cad6b89131257e663b8
BLAKE2b-256 e1300fdb9a66536618f9e6b59f03893917c9a6781dcdd7bac11600c2319f991c

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