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-4.1.3.tar.gz (7.2 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-4.1.3-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shared_utils_ems-4.1.3.tar.gz
  • Upload date:
  • Size: 7.2 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-4.1.3.tar.gz
Algorithm Hash digest
SHA256 02844c1ff5c102676f0ee1bed8a6f2647cef4b3e5ceb0825a47f19fb9dd8bef0
MD5 0957389164c8f088126d1f0f530cafb7
BLAKE2b-256 6b2c140560c8940d84f3c44c85cd84365b937a93d7ff189c815f61a91f66f60c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for shared_utils_ems-4.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 848e6200c49bfffcc601c11969ad8e242b8e73ff03e6e4e03614d12291136806
MD5 f90963913d8f8dddf809a321609ea2be
BLAKE2b-256 134bbab399b956f5f4a9fa929cbe865a9b623ae91118a0a5aab86f1ca269a371

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