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

Uploaded Python 3

File details

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

File metadata

  • Download URL: shared_utils_ems-4.1.2.tar.gz
  • Upload date:
  • Size: 7.1 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.2.tar.gz
Algorithm Hash digest
SHA256 f5269f8cbd66ddedece561d72e44857fa6c8317668c42c6b1ea73d63090c0ade
MD5 ddde20275efb9068c2d63af652edb911
BLAKE2b-256 35d8a1f47ccd2409958d67ab25027272cb0f6c637b31b6e23367766bf5ad6c56

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for shared_utils_ems-4.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 70f5de879a890834899d1c7eed229264ec2cf3ccf635e3dedbd17c45353c3b6a
MD5 64cd930498365508ef98774c3298167b
BLAKE2b-256 11ef44c27df2c3ddeff7fdc6766a11b3630a82a7af2929bface43519289657ce

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