Metadata-Version: 2.4
Name: ruf-common
Version: 1.1.0
Summary: Functions common to several of Brian's Python projects.
Author-email: Brian Ruf <Brian@RufRisk.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/brian-ruf/ruf-common-python
Project-URL: Repository, https://github.com/brian-ruf/ruf-common-python.git
Project-URL: Documentation, https://github.com/brian-ruf/ruf-common-python/blob/main/docs/README.md
Project-URL: Issues, https://github.com/brian-ruf/ruf-common-python/issues
Keywords: utilities,common,helpers
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: loguru>=0.7.3
Requires-Dist: elementpath>=4.7.0
Requires-Dist: pytz>=2025.2
Requires-Dist: tzlocal>=5.3.1
Requires-Dist: geopy>=2.4.1
Requires-Dist: timezonefinder>=8.1.0
Requires-Dist: aiohttp>=3.12.15
Requires-Dist: boto3
Requires-Dist: requests>=2.31.0
Requires-Dist: pycountry>=22.3.5
Requires-Dist: html2text>=2020.1.16
Requires-Dist: packaging>=23.1
Requires-Dist: pyyaml>=6.0.2
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Dynamic: license-file

# ruf-common

[![PyPI version](https://badge.fury.io/py/ruf-common.svg)](https://pypi.org/project/ruf-common/)
[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Overview

A collection of Python utility modules for common tasks including file operations, data format conversions, database interactions, AWS services, and more.

Feedback welcome via [GitHub issues](https://github.com/brian-ruf/ruf-common-python/issues). While I will try to address issues in a timely manner, I only intend to invest in feature requests that align with my project work. Feel free to contribute backward compatible enhancements.

## Installation

```bash
pip install ruf-common
```

## Usage

```python
# Import the entire library
from ruf_common import *

# Or import specific modules
from ruf_common import data, helper, lfs
```

## Modules

The following modules are available:

- `aws`: Functions for interacting with AWS services
- `country_code_converter`: Functions for converting between country code formats
- `data`: Functions for managing and manipulating XML, JSON and YAML content
- `database`: Functions for interacting with a database. These functions operate the same for all supported databases
- `helper`: Various helper functions
- `html_to_markdown`: Functions for converting HTML content to Markdown
- `lfs`: Functions for interacting with the local file system (LFS)
- `logging`: Logging configuration and utilities
- `network`: Functions for network operations
- `stats`: Statistical helper functions
- `timezone_lookup`: Functions for timezone lookups based on location
- `xml_formatter`: Functions for formatting XML content

## License

MIT
