CustomModules


NameCustomModules JSON
Version 2.0.3 PyPI version JSON
download
home_pagehttps://github.com/Serpensin/CustomModules-Python
SummaryA collection of custom Python modules for Discord bots and utilities
upload_time2025-10-31 00:25:24
maintainerNone
docs_urlNone
authorSerpensin
requires_python>=3.10
licenseNone
keywords discord bot utilities modules custom
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # CustomModules

[![PyPI version](https://img.shields.io/pypi/v/CustomModules.svg)](https://pypi.org/project/CustomModules/)
[![Python versions](https://img.shields.io/pypi/pyversions/CustomModules.svg)](https://pypi.org/project/CustomModules/)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
[![Build Status](https://github.com/Serpensin/CustomModules-Python/actions/workflows/test-build.yml/badge.svg)](https://github.com/Serpensin/CustomModules-Python/actions/workflows/test-build.yml)
[![PyPI downloads](https://img.shields.io/pypi/dm/CustomModules.svg)](https://pypi.org/project/CustomModules/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

A collection of custom Python modules for Discord bots and various utilities.

## ✨ What's New in v2.0.2

- **Universal Logger Support**: All modules now support optional logger parameter with hierarchical child logger pattern
- **Improved Security**: Fixed dependency issues and passed all Snyk security scans
- **Code Quality**: Achieved 10/10 pylint score with black formatting and flake8 compliance

## Installation

Install the base package:
```bash
pip install CustomModules
```

Install with specific module dependencies:
```bash
# Install with a specific module's dependencies
pip install CustomModules[statdock]
pip install CustomModules[databasehandler]
pip install CustomModules[loghandler]

# Install multiple modules
pip install CustomModules[statdock,databasehandler,loghandler]

# Install all modules with all dependencies
pip install CustomModules[all]
```

## Available Modules

- **AppTranslation** - Discord Application translation utilities
- **BitmapHandler** - Bitmap manipulation and handling
- **BotDirectory** - Bot directory management
- **DatabaseHandler** - Multi-database async handler (SQLite, MySQL, PostgreSQL, MongoDB)
- **Googletrans** - Google Translate integration
- **InviteTracker** - Discord invite tracking
- **Killswitch** - Dead by Daylight killswitch monitoring
- **Libretrans** - LibreTranslate integration
- **LogHandler** - Advanced logging with colored console output
- **Patchnotes** - Patch notes management for DeadByDaylight
- **PrivateVoice** - Private voice channel management
- **RandomUsernames** - Random username generation
- **StatDock** - Statistics tracking for Discord
- **Steam** - Steam API integration
- **SteamCharts** - Steam Charts data retrieval
- **Twitch** - Twitch API integration

## Usage

Import modules using dot notation:
```python
from CustomModules.bitmap_handler import BitmapHandler
from CustomModules.database_handler import DatabaseHandler
from CustomModules.log_handler import LogManager
from CustomModules.stat_dock import setup as stat_dock_setup
```

### Logger Support (v2.0.2+)

All modules now support optional logger parameter for better debugging and monitoring:

```python
import logging
from CustomModules.bitmap_handler import BitmapHandler
from CustomModules.steam import API as SteamAPI

# Create a parent logger
logger = logging.getLogger('MyApp')

# All modules create child loggers under CustomModules.ModuleName
bitmap = BitmapHandler(['read', 'write'], logger=logger)
# Creates logger: MyApp.CustomModules.BitmapHandler

steam_api = SteamAPI(api_key='your_key', logger=logger)
# Creates logger: MyApp.CustomModules.Steam

# Function-based modules use set_logger()
from CustomModules import killswitch
killswitch.set_logger(logger)
# Creates logger: MyApp.CustomModules.Killswitch
```

## Requirements

- Python 3.10 or higher
- Additional dependencies are installed based on which modules you use (see extras_require)

## License

This project is licensed under the GNU Affero General Public License v3 (AGPL-3.0).

## Documentation

- **[INSTALLATION.md](INSTALLATION.md)** - Detailed installation guide for end users
- **[DEVELOPMENT.md](DEVELOPMENT.md)** - Guide for developers and contributors
- **[TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - Common issues and solutions

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## Support

For issues and questions, please use the [GitHub Issues](https://github.com/Serpensin/CustomModules-Python/issues) page.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Serpensin/CustomModules-Python",
    "name": "CustomModules",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "discord, bot, utilities, modules, custom",
    "author": "Serpensin",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/8e/70/1b9abfe1d85b288c48042d73da397b00f1a0a142e1cb1b503312ef151902/custommodules-2.0.3.tar.gz",
    "platform": null,
    "description": "# CustomModules\n\n[![PyPI version](https://img.shields.io/pypi/v/CustomModules.svg)](https://pypi.org/project/CustomModules/)\n[![Python versions](https://img.shields.io/pypi/pyversions/CustomModules.svg)](https://pypi.org/project/CustomModules/)\n[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)\n[![Build Status](https://github.com/Serpensin/CustomModules-Python/actions/workflows/test-build.yml/badge.svg)](https://github.com/Serpensin/CustomModules-Python/actions/workflows/test-build.yml)\n[![PyPI downloads](https://img.shields.io/pypi/dm/CustomModules.svg)](https://pypi.org/project/CustomModules/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nA collection of custom Python modules for Discord bots and various utilities.\n\n## \u2728 What's New in v2.0.2\n\n- **Universal Logger Support**: All modules now support optional logger parameter with hierarchical child logger pattern\n- **Improved Security**: Fixed dependency issues and passed all Snyk security scans\n- **Code Quality**: Achieved 10/10 pylint score with black formatting and flake8 compliance\n\n## Installation\n\nInstall the base package:\n```bash\npip install CustomModules\n```\n\nInstall with specific module dependencies:\n```bash\n# Install with a specific module's dependencies\npip install CustomModules[statdock]\npip install CustomModules[databasehandler]\npip install CustomModules[loghandler]\n\n# Install multiple modules\npip install CustomModules[statdock,databasehandler,loghandler]\n\n# Install all modules with all dependencies\npip install CustomModules[all]\n```\n\n## Available Modules\n\n- **AppTranslation** - Discord Application translation utilities\n- **BitmapHandler** - Bitmap manipulation and handling\n- **BotDirectory** - Bot directory management\n- **DatabaseHandler** - Multi-database async handler (SQLite, MySQL, PostgreSQL, MongoDB)\n- **Googletrans** - Google Translate integration\n- **InviteTracker** - Discord invite tracking\n- **Killswitch** - Dead by Daylight killswitch monitoring\n- **Libretrans** - LibreTranslate integration\n- **LogHandler** - Advanced logging with colored console output\n- **Patchnotes** - Patch notes management for DeadByDaylight\n- **PrivateVoice** - Private voice channel management\n- **RandomUsernames** - Random username generation\n- **StatDock** - Statistics tracking for Discord\n- **Steam** - Steam API integration\n- **SteamCharts** - Steam Charts data retrieval\n- **Twitch** - Twitch API integration\n\n## Usage\n\nImport modules using dot notation:\n```python\nfrom CustomModules.bitmap_handler import BitmapHandler\nfrom CustomModules.database_handler import DatabaseHandler\nfrom CustomModules.log_handler import LogManager\nfrom CustomModules.stat_dock import setup as stat_dock_setup\n```\n\n### Logger Support (v2.0.2+)\n\nAll modules now support optional logger parameter for better debugging and monitoring:\n\n```python\nimport logging\nfrom CustomModules.bitmap_handler import BitmapHandler\nfrom CustomModules.steam import API as SteamAPI\n\n# Create a parent logger\nlogger = logging.getLogger('MyApp')\n\n# All modules create child loggers under CustomModules.ModuleName\nbitmap = BitmapHandler(['read', 'write'], logger=logger)\n# Creates logger: MyApp.CustomModules.BitmapHandler\n\nsteam_api = SteamAPI(api_key='your_key', logger=logger)\n# Creates logger: MyApp.CustomModules.Steam\n\n# Function-based modules use set_logger()\nfrom CustomModules import killswitch\nkillswitch.set_logger(logger)\n# Creates logger: MyApp.CustomModules.Killswitch\n```\n\n## Requirements\n\n- Python 3.10 or higher\n- Additional dependencies are installed based on which modules you use (see extras_require)\n\n## License\n\nThis project is licensed under the GNU Affero General Public License v3 (AGPL-3.0).\n\n## Documentation\n\n- **[INSTALLATION.md](INSTALLATION.md)** - Detailed installation guide for end users\n- **[DEVELOPMENT.md](DEVELOPMENT.md)** - Guide for developers and contributors\n- **[TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - Common issues and solutions\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## Support\n\nFor issues and questions, please use the [GitHub Issues](https://github.com/Serpensin/CustomModules-Python/issues) page.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A collection of custom Python modules for Discord bots and utilities",
    "version": "2.0.3",
    "project_urls": {
        "Bug Reports": "https://github.com/Serpensin/CustomModules-Python/issues",
        "Homepage": "https://github.com/Serpensin/CustomModules-Python",
        "Source": "https://github.com/Serpensin/CustomModules-Python"
    },
    "split_keywords": [
        "discord",
        " bot",
        " utilities",
        " modules",
        " custom"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d87df1d4c11ac85b0af9a2743ef90f6987b0ee3e54947c5ee4c0867046f4f04c",
                "md5": "ccedfb7b5be72b50caf1eb903daf924e",
                "sha256": "70c3e1314aeb65ba6844db54e8841a69e8c4bc734af728c10fda46f1982592f4"
            },
            "downloads": -1,
            "filename": "custommodules-2.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ccedfb7b5be72b50caf1eb903daf924e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 69633,
            "upload_time": "2025-10-31T00:25:23",
            "upload_time_iso_8601": "2025-10-31T00:25:23.380327Z",
            "url": "https://files.pythonhosted.org/packages/d8/7d/f1d4c11ac85b0af9a2743ef90f6987b0ee3e54947c5ee4c0867046f4f04c/custommodules-2.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8e701b9abfe1d85b288c48042d73da397b00f1a0a142e1cb1b503312ef151902",
                "md5": "006dc2f1c835357b23431c9036218e89",
                "sha256": "cb2ef6ec5c499d87d4b89a96a42e00bc1dbe93c9dcb7331eac6117ba93e73700"
            },
            "downloads": -1,
            "filename": "custommodules-2.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "006dc2f1c835357b23431c9036218e89",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 65899,
            "upload_time": "2025-10-31T00:25:24",
            "upload_time_iso_8601": "2025-10-31T00:25:24.790438Z",
            "url": "https://files.pythonhosted.org/packages/8e/70/1b9abfe1d85b288c48042d73da397b00f1a0a142e1cb1b503312ef151902/custommodules-2.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-31 00:25:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Serpensin",
    "github_project": "CustomModules-Python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "custommodules"
}
        
Elapsed time: 3.13968s