devsetgo-lib


Namedevsetgo-lib JSON
Version 0.13.0 PyPI version JSON
download
home_pageNone
SummaryDevSetGo Library is a Python library offering reusable functions for efficient coding. It includes file operations, calendar utilities, pattern matching, advanced logging with loguru, FastAPI endpoints, async database handling, and email validation. Designed for ease of use and versatility, it's a valuable tool for Python developers.
upload_time2024-05-26 21:14:02
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License Copyright (c) 2020 Mike Ryan Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords crud operations fastapi async database calendar utilities development tools email validation file operations library logging loguru pattern matching python reusable functions
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Python:

[![PyPI version fury.io](https://badge.fury.io/py/devsetgo-lib.svg)](https://pypi.python.org/pypi/devsetgo-lib/)
[![Downloads](https://static.pepy.tech/badge/devsetgo-lib)](https://pepy.tech/project/devsetgo-lib)
[![Downloads](https://static.pepy.tech/badge/devsetgo-lib/month)](https://pepy.tech/project/devsetgo-lib)
[![Downloads](https://static.pepy.tech/badge/devsetgo-lib/week)](https://pepy.tech/project/devsetgo-lib)

Support Python Versions

![Static Badge](https://img.shields.io/badge/Python-3.12%20%7C%203.11%20%7C%203.10%20%7C%203.9-blue)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)


CI/CD Pipeline:

[![Testing - Main](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml)
[![Testing - Dev](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml/badge.svg?branch=dev)](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml)
[![Coverage fury.io](coverage-badge.svg)](https://github.com/devsetgo/dsg_lib)

SonarCloud:

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=coverage)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=alert_status)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)

![Static Badge](https://img.shields.io/badge/Documentation-v0.12.2-blue?link=https%3A%2F%2Fdevsetgo.github.io%2Fdevsetgo_lib)


# DevSetGo Common Library

## Introduction
The DevSetGo Common Library is a comprehensive package of common functions designed to eliminate repetitive coding and enhance code reusability. It aims to save developers time and effort across various projects.

## Compatibility and Testing
- **Tested on**: Windows, Linux.
- **Compatibility**: Potentially compatible with MacOS (feedback on issues is appreciated).

## Library Functions
### Common Functions
- **File Functions**:
  - CSV File Functions
  - JSON File Functions
  - Text File Functions
- **Folder Functions**:
  - Make Directory
  - Remove Directory
  - Last File Changed
  - Directory List
- **Calendar Functions**:
  - Get Month
  - Get Month Number
- **Patterns**:
  - Pattern Between Two Characters
- **Logging**:
  - Logging configuration and interceptor

### FastAPI Endpoints
- **Systems Health Endpoints**:
  - Status/Health, Heapdump, Uptime
- **HTTP Codes**:
  - Method to generate HTTP response codes

### Async Database
- Database Config
- Async Session
- CRUD Operations

## Examples and Usage
Refer to the [Recipes Pages](https://devsetgo.github.io/devsetgo_lib/recipes/fastapi/)

## Installation Guide
[Quick Start](https://devsetgo.github.io/devsetgo_lib/quickstart/)

```python
pip install devsetgo-lib

# Aysync database setup
pip install devsetgo-lib[sqlite]
pip install devsetgo-lib[postgres]

# Consider these experimental and untested
pip install devsetgo-lib[oracle]
pip install devsetgo-lib[mssql]
pip install devsetgo-lib[mysql]

# For adding FastAPI endpoints
pip install devsetgo-lib[fastapi]

# Install everything
pip install devsetgo-lib[all]
```


## Contribution and Feedback
Contributions and feedback are highly appreciated. Please refer to our [Contribution Guidelines](https://github.com/devsetgo/devsetgo_lib/blob/main/CONTRIBUTING.md).

## License
[MIT Licensed](https://github.com/devsetgo/devsetgo_lib/blob/main/LICENSE)

## Author Information
[Mike Ryan](https://github.com/devsetgo)

## Further Documentation
For more detailed information, visit [LINK_TO_DETAILED_DOCUMENTATION](https://devsetgo.github.io/devsetgo_lib/).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "devsetgo-lib",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "Mike Ryan <mikeryan56@gmail.com>",
    "keywords": "CRUD operations, FastAPI, async database, calendar utilities, development tools, email validation, file operations, library, logging, loguru, pattern matching, python, reusable functions",
    "author": null,
    "author_email": "Mike Ryan <mikeryan56@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/d5/5e/e9af69839a7c423c39c1c604b4bf444243e7e6ef7b4a5cc1e231135f81ef/devsetgo_lib-0.13.0.tar.gz",
    "platform": null,
    "description": "Python:\n\n[![PyPI version fury.io](https://badge.fury.io/py/devsetgo-lib.svg)](https://pypi.python.org/pypi/devsetgo-lib/)\n[![Downloads](https://static.pepy.tech/badge/devsetgo-lib)](https://pepy.tech/project/devsetgo-lib)\n[![Downloads](https://static.pepy.tech/badge/devsetgo-lib/month)](https://pepy.tech/project/devsetgo-lib)\n[![Downloads](https://static.pepy.tech/badge/devsetgo-lib/week)](https://pepy.tech/project/devsetgo-lib)\n\nSupport Python Versions\n\n![Static Badge](https://img.shields.io/badge/Python-3.12%20%7C%203.11%20%7C%203.10%20%7C%203.9-blue)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n\n\nCI/CD Pipeline:\n\n[![Testing - Main](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml)\n[![Testing - Dev](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml/badge.svg?branch=dev)](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml)\n[![Coverage fury.io](coverage-badge.svg)](https://github.com/devsetgo/dsg_lib)\n\nSonarCloud:\n\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=coverage)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=alert_status)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)\n\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)\n\n![Static Badge](https://img.shields.io/badge/Documentation-v0.12.2-blue?link=https%3A%2F%2Fdevsetgo.github.io%2Fdevsetgo_lib)\n\n\n# DevSetGo Common Library\n\n## Introduction\nThe DevSetGo Common Library is a comprehensive package of common functions designed to eliminate repetitive coding and enhance code reusability. It aims to save developers time and effort across various projects.\n\n## Compatibility and Testing\n- **Tested on**: Windows, Linux.\n- **Compatibility**: Potentially compatible with MacOS (feedback on issues is appreciated).\n\n## Library Functions\n### Common Functions\n- **File Functions**:\n  - CSV File Functions\n  - JSON File Functions\n  - Text File Functions\n- **Folder Functions**:\n  - Make Directory\n  - Remove Directory\n  - Last File Changed\n  - Directory List\n- **Calendar Functions**:\n  - Get Month\n  - Get Month Number\n- **Patterns**:\n  - Pattern Between Two Characters\n- **Logging**:\n  - Logging configuration and interceptor\n\n### FastAPI Endpoints\n- **Systems Health Endpoints**:\n  - Status/Health, Heapdump, Uptime\n- **HTTP Codes**:\n  - Method to generate HTTP response codes\n\n### Async Database\n- Database Config\n- Async Session\n- CRUD Operations\n\n## Examples and Usage\nRefer to the [Recipes Pages](https://devsetgo.github.io/devsetgo_lib/recipes/fastapi/)\n\n## Installation Guide\n[Quick Start](https://devsetgo.github.io/devsetgo_lib/quickstart/)\n\n```python\npip install devsetgo-lib\n\n# Aysync database setup\npip install devsetgo-lib[sqlite]\npip install devsetgo-lib[postgres]\n\n# Consider these experimental and untested\npip install devsetgo-lib[oracle]\npip install devsetgo-lib[mssql]\npip install devsetgo-lib[mysql]\n\n# For adding FastAPI endpoints\npip install devsetgo-lib[fastapi]\n\n# Install everything\npip install devsetgo-lib[all]\n```\n\n\n## Contribution and Feedback\nContributions and feedback are highly appreciated. Please refer to our [Contribution Guidelines](https://github.com/devsetgo/devsetgo_lib/blob/main/CONTRIBUTING.md).\n\n## License\n[MIT Licensed](https://github.com/devsetgo/devsetgo_lib/blob/main/LICENSE)\n\n## Author Information\n[Mike Ryan](https://github.com/devsetgo)\n\n## Further Documentation\nFor more detailed information, visit [LINK_TO_DETAILED_DOCUMENTATION](https://devsetgo.github.io/devsetgo_lib/).\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2020 Mike Ryan  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "DevSetGo Library is a Python library offering reusable functions for efficient coding. It includes file operations, calendar utilities, pattern matching, advanced logging with loguru, FastAPI endpoints, async database handling, and email validation. Designed for ease of use and versatility, it's a valuable tool for Python developers.",
    "version": "0.13.0",
    "project_urls": {
        "Documentation": "https://devsetgo.github.io/devsetgo_lib/",
        "Homepage": "https://github.com/devsetgo/devsetgo_lib",
        "Repository": "https://github.com/devsetgo/devsetgo_lib"
    },
    "split_keywords": [
        "crud operations",
        " fastapi",
        " async database",
        " calendar utilities",
        " development tools",
        " email validation",
        " file operations",
        " library",
        " logging",
        " loguru",
        " pattern matching",
        " python",
        " reusable functions"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0ad0723f2a6eb78c7fc2226a5e24f74d3650e37914518caca67191f83d321241",
                "md5": "a7b7a4088ffb857e342c7244fcdaa3d1",
                "sha256": "f4beeaeae495c7c3a28ba1094633895dce80cc0c042ca7aaed831af41da42bd2"
            },
            "downloads": -1,
            "filename": "devsetgo_lib-0.13.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a7b7a4088ffb857e342c7244fcdaa3d1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 46288,
            "upload_time": "2024-05-26T21:14:00",
            "upload_time_iso_8601": "2024-05-26T21:14:00.393225Z",
            "url": "https://files.pythonhosted.org/packages/0a/d0/723f2a6eb78c7fc2226a5e24f74d3650e37914518caca67191f83d321241/devsetgo_lib-0.13.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d55ee9af69839a7c423c39c1c604b4bf444243e7e6ef7b4a5cc1e231135f81ef",
                "md5": "09b7e04fa91eb7653be5d52ae75984b8",
                "sha256": "837828abf1f3879102fcbfd7354cf4d536eb2d93c019741ad52779fb237caea2"
            },
            "downloads": -1,
            "filename": "devsetgo_lib-0.13.0.tar.gz",
            "has_sig": false,
            "md5_digest": "09b7e04fa91eb7653be5d52ae75984b8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 38303,
            "upload_time": "2024-05-26T21:14:02",
            "upload_time_iso_8601": "2024-05-26T21:14:02.622303Z",
            "url": "https://files.pythonhosted.org/packages/d5/5e/e9af69839a7c423c39c1c604b4bf444243e7e6ef7b4a5cc1e231135f81ef/devsetgo_lib-0.13.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-26 21:14:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "devsetgo",
    "github_project": "devsetgo_lib",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "devsetgo-lib"
}
        
Elapsed time: 0.25400s