utility-toolkit


Nameutility-toolkit JSON
Version 0.2.1 PyPI version JSON
download
home_pageNone
SummaryA comprehensive toolkit for AWS operations, database handling, and general utilities.
upload_time2024-10-21 17:22:37
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords tools_box tools utilities toolkit
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Utility Toolkit

Utility Toolkit is a comprehensive Python package that provides a collection of tools for AWS operations, database handling (PostgreSQL and SQLite), and general utility functions.

## Installation

You can install Utility Toolkit using pip:
``` cmd
pip install utility_toolkit
```

## Features

- AWS Tools: Functions for interacting with various AWS services
- PostgreSQL Handler: Easy-to-use interface for PostgreSQL database operations
- SQLite Handler: Simplified SQLite database management
- General Tools: A collection of utility functions for common tasks

## Changes and What's New

- **Version 0.2.1** (Date: 2024-10-21)
  - Fix import issue.

- **Version 0.2.0** (Date: 2024-10-21)
  - Remove log decoration to let user log as needed.

- **Version 0.1.9** (Date: 2024-10-11)
  - Improved logs.
  - add more functions to global_tools.
  - add sonarqube to the project.

- **Version 0.1.8** (Date: 2024-10-04)
  - Improved error handling in PostgreSQL and SQLite handlers.
  - Introduced new utility functions for dynamodb handler.
  - Enhance logging capabilities for better debugging.
  - Performance optimizations and bug fixes.

## Usage

Here are some quick examples of how to use Utility Toolkit:


```

python from utility_toolkit import aws_tools, postgresql_handler, sqlite_handler, general_tools

# AWS example

s3_content = aws_tools.get_s3_file_content('s3://my-bucket/my-file.txt')

# PostgreSQL example

with postgresql_handler.PostgreSQLConnection('my_db', 'user', 'password', 'localhost') as conn: results = conn.execute_query('SELECT * FROM my_table')

# SQLite example

with sqlite_handler.SQLiteConnection('my_database.db') as conn: conn.execute_query('CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT)')

# General tools example

general_tools.create_directory_if_not_exists('my_new_directory')

```

For more detailed usage instructions, please refer to the documentation.

## Contributing

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

## License

This project is licensed under the MIT License - see the LICENSE file for details.

```

6.  **Choose a License**

Choose an appropriate license (e.g., MIT License) and add it to the LICENSE file.

7.  **Create .gitignore**

Create a  `.gitignore`  file in the root directory:

```
__pycache__/
*.py[cod]
*.so
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
.venv/
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "utility-toolkit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "tools_box, tools, utilities, toolkit",
    "author": null,
    "author_email": "Eslam Hasanen <Eslamspot@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/a8/e1/4575ad886ce30d12fcb6cc5655a2cfbf0b2b5e05b650375252b53d39fade/utility_toolkit-0.2.1.tar.gz",
    "platform": null,
    "description": "# Utility Toolkit\n\nUtility Toolkit is a comprehensive Python package that provides a collection of tools for AWS operations, database handling (PostgreSQL and SQLite), and general utility functions.\n\n## Installation\n\nYou can install Utility Toolkit using pip:\n``` cmd\npip install utility_toolkit\n```\n\n## Features\n\n- AWS Tools: Functions for interacting with various AWS services\n- PostgreSQL Handler: Easy-to-use interface for PostgreSQL database operations\n- SQLite Handler: Simplified SQLite database management\n- General Tools: A collection of utility functions for common tasks\n\n## Changes and What's New\n\n- **Version 0.2.1** (Date: 2024-10-21)\n  - Fix import issue.\n\n- **Version 0.2.0** (Date: 2024-10-21)\n  - Remove log decoration to let user log as needed.\n\n- **Version 0.1.9** (Date: 2024-10-11)\n  - Improved logs.\n  - add more functions to global_tools.\n  - add sonarqube to the project.\n\n- **Version 0.1.8** (Date: 2024-10-04)\n  - Improved error handling in PostgreSQL and SQLite handlers.\n  - Introduced new utility functions for dynamodb handler.\n  - Enhance logging capabilities for better debugging.\n  - Performance optimizations and bug fixes.\n\n## Usage\n\nHere are some quick examples of how to use Utility Toolkit:\n\n\n```\n\npython from utility_toolkit import aws_tools, postgresql_handler, sqlite_handler, general_tools\n\n# AWS example\n\ns3_content = aws_tools.get_s3_file_content('s3://my-bucket/my-file.txt')\n\n# PostgreSQL example\n\nwith postgresql_handler.PostgreSQLConnection('my_db', 'user', 'password', 'localhost') as conn: results = conn.execute_query('SELECT * FROM my_table')\n\n# SQLite example\n\nwith sqlite_handler.SQLiteConnection('my_database.db') as conn: conn.execute_query('CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT)')\n\n# General tools example\n\ngeneral_tools.create_directory_if_not_exists('my_new_directory')\n\n```\n\nFor more detailed usage instructions, please refer to the documentation.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n```\n\n6.  **Choose a License**\n\nChoose an appropriate license (e.g., MIT License) and add it to the LICENSE file.\n\n7.  **Create .gitignore**\n\nCreate a  `.gitignore`  file in the root directory:\n\n```\n__pycache__/\n*.py[cod]\n*.so\n.Python\nbuild/\ndevelop-eggs/\ndist/\ndownloads/\neggs/\n.eggs/\nlib/\nlib64/\nparts/\nsdist/\nvar/\nwheels/\n*.egg-info/\n.installed.cfg\n*.egg\n.venv/\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A comprehensive toolkit for AWS operations, database handling, and general utilities.",
    "version": "0.2.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/eslamspot/utility_toolkit/issues",
        "Homepage": "https://www.idealisticsolutions.com"
    },
    "split_keywords": [
        "tools_box",
        " tools",
        " utilities",
        " toolkit"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d5c31cb1683f04ba67c71bd43bb4456150d35f19cfc1d9d63e313cefaf3d11e6",
                "md5": "270c23b2579d4755fb4bdf8072d939fe",
                "sha256": "4f81e038e2566161ed4e71747c76b5cf57ac6f4a6bcf0c40ed3358898cfeb7a4"
            },
            "downloads": -1,
            "filename": "utility_toolkit-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "270c23b2579d4755fb4bdf8072d939fe",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 36375,
            "upload_time": "2024-10-21T17:22:34",
            "upload_time_iso_8601": "2024-10-21T17:22:34.981073Z",
            "url": "https://files.pythonhosted.org/packages/d5/c3/1cb1683f04ba67c71bd43bb4456150d35f19cfc1d9d63e313cefaf3d11e6/utility_toolkit-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a8e14575ad886ce30d12fcb6cc5655a2cfbf0b2b5e05b650375252b53d39fade",
                "md5": "73b781ad356fc00c335d7e8afb451c8e",
                "sha256": "c4f4b668e0a904d564ef35a6217d53151df72418400e39df4259a0f99e804fc6"
            },
            "downloads": -1,
            "filename": "utility_toolkit-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "73b781ad356fc00c335d7e8afb451c8e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 35189,
            "upload_time": "2024-10-21T17:22:37",
            "upload_time_iso_8601": "2024-10-21T17:22:37.122871Z",
            "url": "https://files.pythonhosted.org/packages/a8/e1/4575ad886ce30d12fcb6cc5655a2cfbf0b2b5e05b650375252b53d39fade/utility_toolkit-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-21 17:22:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "eslamspot",
    "github_project": "utility_toolkit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "utility-toolkit"
}
        
Elapsed time: 0.38014s