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

Uploaded Source

Built Distribution

msabase-0.0.131-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: msabase-0.0.131.tar.gz
  • Upload date:
  • Size: 28.0 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.131.tar.gz
Algorithm Hash digest
SHA256 c6e3ce0b4af6bf4d80d169f4890f87ff9f4d1f56cf009c8a0afb1d0338680b97
MD5 8a17305e003e19a0f47de3c704865792
BLAKE2b-256 ed084a89982cf75574f25adc3eab8758147419ff0fdd029734dd94790815ece2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: msabase-0.0.131-py3-none-any.whl
  • Upload date:
  • Size: 30.6 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.131-py3-none-any.whl
Algorithm Hash digest
SHA256 301841bd30cf60dfbdb31bc444716ae4b998d73e6e1fbb799a2501acbea60e4e
MD5 b4c858805a2db25c2a0f47ec0ccf217c
BLAKE2b-256 a5918af8e1b77c66cd12281c591fd32ded4403017c9794190ce50b70ecc8b8a4

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