Metadata-Version: 2.1
Name: basefunctions
Version: 0.3.4
Summary: simple library to have some commonly used functions for everyday purpose
Author-email: NeuralDevelopment <neutro2@outlook.de>
License: MIT License
        
        Copyright (c) 2023 NeuralDevelopment
        
        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.
        
Project-URL: Homepage, https://dev.azure.com/neuraldevelopment/basefunctions
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas>=2.0
Requires-Dist: python-decouple>=3.4
Requires-Dist: psycopg2-binary>=2.9
Requires-Dist: sqlalchemy>=2.0
Provides-Extra: dev
Provides-Extra: test
Requires-Dist: pytest>=7.4; extra == "test"

# Introduction 
simple library to have some commonly used functions for everyday purpose. 
The functions include some convenience functions for file handling as well 
as a threadpool class with automatic retry and timeout functionality.  

# Getting Started
There are the following functionalities in this lib:
- database - some convienience functions for sql handling
- filefunctions - some convienience functions for file handling
- threadpool - a threadpool class with message system

# Installing
pip install basefunctions

# Usage

## Using convenience file functions
import basefunctions as bf

bf.get_current_directory()
/Users/neutro2/

## Using threadpool class
see example.py file for a concrete usage of the threadpool class

# Build and Test
1. Install virtual environment 
python3 -m venv .venv
source .venv/bin/activate
pip install build
pip install twine
pip install pytest

2. Build a package:
python3 -m build

3. Run the testcases  
pip install -e .
cd tests
pytest

4. Upload the package to pypi.org
python3 -m twine upload dist/*

# Project Homepage
https://dev.azure.com/neuraldevelopment/basefunctions

# Contribute
If you find a defect or suggest a new function, please send an eMail to neutro2@outlook.de
