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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: msabase-0.0.114.tar.gz
  • Upload date:
  • Size: 27.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/6.2.0-32-generic

File hashes

Hashes for msabase-0.0.114.tar.gz
Algorithm Hash digest
SHA256 0c7417baa146594651fd2a04d6b3b3fe7676318a136b8923007c040a8ca3f57e
MD5 7f0928e46b5828230b0219edae96bb3d
BLAKE2b-256 8055ec3eb5e044732ed46e9ee43601fb6d0688a42f5499c02d6a1bdfb6fb5a64

See more details on using hashes here.

File details

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

File metadata

  • Download URL: msabase-0.0.114-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.10.12 Linux/6.2.0-32-generic

File hashes

Hashes for msabase-0.0.114-py3-none-any.whl
Algorithm Hash digest
SHA256 9d8d152622936e3ede5374641ad2584ef09d31d8cb1a53ab921c8be304199734
MD5 4adfd3edafe8b91c49c05d0f22ee0f0f
BLAKE2b-256 406f40c45f3b9419e76d9d8638350ee8425924c378db2618055be1a0deb5a4d7

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