codealchemy 1.1

A package with decorators to capture execution time and create log groups for functions.

CodeAlchemy

codealchemy is a Python package that provides decorators for capturing the execution time of functions and creating log groups for functions. This package can be used to enhance logging and performance monitoring in your Python projects.

Installation

You can install codealchemy using pip:

pip install codealchemy

Usage

Here is how you can use the decorators provided by codealchemy in your Python code:

1. code execution time

from codealchemy import code_execution_time

@code_execution_time
def example_function():
    import time
    time.sleep(2)
    print("Function executed")

example_function()

2. Log groups

from codealchemy import log_group
import logging

# Ensure the logger level is set to INFO
logging.getLogger(__name__).setLevel(logging.INFO)

@log_group("MainGroup")
def main_function():
    print("Inside main function")
    print("*"*20)
    logging.info("Inside main function")
    inner_function()

@log_group("InnerGroup")
def inner_function():
    print("Inside inner function")
    print("*"*20)
    logging.info("Inside inner function")
    innermost_function()

@log_group("InnermostGroup")
def innermost_function():
    print("Inside innermost function")
    print("*"*20)
    logging.info("Inside innermost function")
    print("Innermost function executed")

main_function()

Decorators

• code_execution_time: This decorator logs the execution time of the decorated function.
• log_group(group_name): This decorator logs entry and exit points of the decorated function, grouping logs under a specified group name.

Development

If you want to contribute to the development of codealchemy, you can set up a development environment by following these steps:

1. Clone the repository:

   git clone https://github.com/girishcodealchemy/codealchemy.git
   

2. Navigate to the project directory:

   cd codealchemy
   

3. Install the package in editable mode with development dependencies:

   pip install -e .[dev]
   

Publishing to PyPI

This project uses GitHub Actions to automate the process of publishing the package to PyPI.

GitHub Action Workflow

The GitHub Action is defined in .github/workflows/publish-to-pypi.yml. It triggers on new releases and performs the following steps:

1. Checkout the code.
2. Set up Python.
3. Install dependencies (setuptools, wheel, twine).
4. Build the package.
5. Publish the package to PyPI using credentials stored in GitHub Secrets.

Setting Up GitHub Secrets

To securely store your PyPI credentials, add the following secrets to your GitHub repository:

1. PYPI_USERNAME: Your PyPI username.
2. PYPI_PASSWORD: Your PyPI password.

Creating a New Release

To trigger the GitHub Action and publish the package to PyPI:

1. Navigate to your GitHub repository.
2. Go to the Releases tab.
3. Click Draft a new release.
4. Fill in the release details (tag version, release title, description).
5. Click Publish release.

The GitHub Action will automatically run and upload the package to PyPI.

License

This project is licensed under the MIT License. See the LICENSE file for more details.