Skip to main content

A shared utility library for event management system based on microservices architecture.

Project description

Shared Library Approach in Microservices

Why Use a Shared Library?

In a microservices architecture, multiple services often need common functionalities such as logging, error handling, authentication, and utility functions. Instead of duplicating code across services, we use a shared library to:

Reduce Code Duplication : Avoid repeating the same logic in every service.
Ensure Consistency : Standardized utilities across all services.
Simplify Maintenance : Fix issues or update features in one place.
Improve Scalability : Microservices remain lightweight and focused.
Enhance Deployment : Easier to manage updates and dependencies.

Installation

To install the shared library in your microservices, run:

pip install shared-utils

Or specify it in your requirements.txt:

shared-utils>=1.0.0

Usage

Inside any microservice, import and use the shared utilities:

from shared_utils.logging import setup_logger

logger = setup_logger(__name__)
logger.info("Shared utilities are working!")

Updating shared_utils

If a new feature or bug fix is added to shared_utils, follow these steps:

  1. Modify the code: Implement your changes in shared_utils.

  2. Update version: Change the version in setup.py (e.g., 1.0.1 to 1.0.2).

  3. Build the package:

    python setup.py sdist bdist_wheel
    
  4. Publish to PyPI:

    twine upload dist/*
    
  5. Upgrade in services:

    pip install --upgrade shared-utils
    

Versioning

We follow Semantic Versioning (SemVer):

  • MAJOR – Breaking changes.
  • MINOR – New features (backward compatible).
  • PATCH – Bug fixes and improvements.

release history

pypi

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shared_utils_ems-3.2.0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shared_utils_ems-3.2.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file shared_utils_ems-3.2.0.tar.gz.

File metadata

  • Download URL: shared_utils_ems-3.2.0.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.10

File hashes

Hashes for shared_utils_ems-3.2.0.tar.gz
Algorithm Hash digest
SHA256 73db88297003a438ada05c0667084073e869ebbc51e09af6a0396755e1b80eed
MD5 76b18bcfd7b9b6662aed14f424340e1f
BLAKE2b-256 d23189553016f200f453869a2207ef1e3c35daa6a153bd14612f296d7dccf805

See more details on using hashes here.

File details

Details for the file shared_utils_ems-3.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for shared_utils_ems-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 982239a6f854fb97622fe9b0185207316d00f0284abf05b6dccf292abf0db0b3
MD5 71b105cb4555e56faa2b2a3057ffba56
BLAKE2b-256 5c8d92cf5bfa19fcc858348c55aa3a5d12ef793dad1d1dbaf1bdb7b1f84873ea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page