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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: msabase-0.0.115.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.115.tar.gz
Algorithm Hash digest
SHA256 92cdc03d4bc556dd1f6cbe0f08e7a36471a97408eec21848620a3b90b178e290
MD5 34687e8d13cda16630406c92534df3a2
BLAKE2b-256 8e2473acbb309b91e95a343d8dc04c2d4c6bcf92b7629734d0f09fe0754b003b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: msabase-0.0.115-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.115-py3-none-any.whl
Algorithm Hash digest
SHA256 f4ce25320da42f4deb77d87838f5fa9c0323b0ec6e1045fbfdad78338b581c88
MD5 b02aab8bf163ef664965c864497dea32
BLAKE2b-256 c18f40a1b09f21d53514017c1060178da561644200e7b96548ccb435f9720824

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