added description to __init__.py; removed build and dist files

.gitignore

@@ -1,3 +1,6 @@
 /.venv/
 /.idea/
 /test/log/
+/build/
+/dist/
+/eh_logging.egg-info/

.idea/eh_logger.iml

@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="PYTHON_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/.venv" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

.idea/misc.xml

@@ -3,5 +3,5 @@
   <component name="Black">
     <option name="sdkName" value="Python 3.12 (ehLogger)" />
   </component>
-  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.12 (ehLogger)" project-jdk-type="Python SDK" />
+  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.12 (eh_logging)" project-jdk-type="Python SDK" />
 </project>

.idea/modules.xml

@@ -2,7 +2,7 @@
 <project version="4">
   <component name="ProjectModuleManager">
     <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/eh_logger.iml" filepath="$PROJECT_DIR$/.idea/eh_logger.iml" />
+      <module fileurl="file://$PROJECT_DIR$/.idea/eh_logging.iml" filepath="$PROJECT_DIR$/.idea/eh_logging.iml" />
     </modules>
   </component>
 </project>

.run/build.run.xml

@@ -1,6 +1,6 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="build" type="PythonConfigurationType" factoryName="Python">
-    <module name="eh_logger" />
+    <module name="eh_logging" />
     <option name="ENV_FILES" value="" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
@@ -8,7 +8,7 @@
       <env name="PYTHONUNBUFFERED" value="1" />
     </envs>
     <option name="SDK_HOME" value="" />
-    <option name="SDK_NAME" value="Python 3.12 (ehLogger)" />
+    <option name="SDK_NAME" value="Python 3.12 (eh_logging)" />
     <option name="WORKING_DIRECTORY" value="" />
     <option name="IS_MODULE_SDK" value="false" />
     <option name="ADD_CONTENT_ROOTS" value="true" />

README.md

@@ -1,5 +1,5 @@
 
-# ehLogger
+# eh_logging
 
 > Simple helper to get easier formatted logger from the python logging module
 

docs/README.md

@@ -1,13 +1,13 @@
 
-# eh-logger
+# eh_logging
 
 > Simple helper to get easier formatted logger from the python logging module
 
 # install
 
-pip install git+https://git.eishausener.dev/Eishausener/eh-logger \
+pip install git+https://git.eishausener.dev/Eishausener/eh_logging \
 or \
-pip install git+https://github.com/Eishausener/eh-logger
+pip install git+https://github.com/Eishausener/eh_logging
 
 # usage
 

eh_logging/README.md

@@ -1,5 +1,5 @@
 
-# ehLogger
+# eh_logging
 
 > Simple helper to get easier formatted logger from the python logging module
 

eh_logging/__init__.py

@@ -1,3 +1,11 @@
+"""
+eh_logging
+^^^^^^^^^^
+
+Simple helper to get easier formatted logger from the python logging module
+"""
+
+
 from __future__ import annotations
 
 from functools import wraps
@@ -25,9 +33,9 @@ __all__ = tuple(logging__all__ + [
     'set_default_logger',
     'warning',
 ])
-__version__ = '0.1.2'
+__version__ = '0.1.6'
 __author__ = 'Eishausener <code@eishausener.de>'
-__name__ = 'eh-logger'
+__name__ = 'eh_logging'
 
 ##########
 # config #

eh_logging/eh_logger.egg-info/PKG-INFO

@@ -1,107 +0,0 @@
-Metadata-Version: 2.1
-Name: eh-logger
-Version: 0.1.1
-Summary: Simple helper to get easier formatted logger from the python logging module
-Home-page: https://git.eishausener.dev/Eishausener/eh-logger
-Author: Eishausener <code@eishausener.de>
-Author-email: code@eishausener.de
-License: MIT
-Project-URL: issue tracker, https://git.eishausener.dev/Eishausener/eh-logger/issues
-Classifier: License :: OSI Approved :: MIT License
-Description-Content-Type: text/markdown
-Provides-Extra: dev
-Requires-Dist: twine; extra == "dev"
-Requires-Dist: wheel; extra == "dev"
-Requires-Dist: setuptools; extra == "dev"
-
-
-# eh-logger
-
-> Simple helper to get easier formatted logger from the python logging module
-
-# install
-
-pip install git+https://git.eishausener.dev/Eishausener/eh-logger \
-or \
-pip install git+https://github.com/Eishausener/eh-logger
-
-# usage
-
-import eh-logging, create a formatted logger and use the logger
-
-```python
-# import
-import eh_logging as logging
-
-# create formatted logger
-formatted_logger = logging.get_formatted_logger(
-    'formatted_logger',
-    console=True,
-    console_level=logging.DEBUG,
-    file=True,
-    file_path=r'log\formatted_logger.log',
-    file_level=logging.DEBUG,
-    file_backup_count=5,
-    file_rotate='h',
-)
-
-# use the logger
-formatted_logger.debug('Example formatted DEBUG Message')
-formatted_logger.info('Example formatted INFO Message')
-formatted_logger.warning('Example formatted WARNING Message')
-formatted_logger.error('Example formatted ERROR Message')
-formatted_logger.critical('Example formatted CRITICAL Message')
-
-```
-
-use the decorator with the INFO level
-
-```python
-# import
-import eh_logging as logging
-
-# set default logger to DEBUG level to see output
-logging.set_default_level(logging.DEBUG)
-
-
-# use logging decorator with default logger
-@logging.Decorator.info(arg=True, kwarg=True, return_value=True, decimal_places=1)
-def example_function(first_param, second_param, *args, **kwargs):
-    return first_param, second_param, *args, *kwargs
-
-
-# execute function
-example_function('Hello', 'world', 'test', 'example', hello='world', world='test')
-
-```
-
-use the decorator with own logger
-
-```python
-# import
-import eh_logging as logging
-
-
-# create formatted logger
-formatted_logger = logging.get_formatted_logger(
-    'example_decorator_logger',
-    console=True,
-    console_level=logging.DEBUG,
-    file=True,
-    file_path=r'log\decorator_logger.log',
-    file_level=logging.DEBUG,
-    file_backup_count=5,
-    file_rotate='h',
-)
-
-
-# use logging decorator with custom logger
-@logging.Decorator.debug(logger=formatted_logger, arg=True, kwarg=True, return_value=True, decimal_places=1)
-def example_function(first_param, second_param, *args, **kwargs):
-    return first_param, second_param, *args, *kwargs
-
-
-# execute function
-example_function('Hello', 'world', 'test', 'example', hello='world', world='test')
-
-```

eh_logging/eh_logger.egg-info/SOURCES.txt

@@ -1,8 +0,0 @@
-README.md
-setup.py
-eh_logging/eh_logger.egg-info/PKG-INFO
-eh_logging/eh_logger.egg-info/SOURCES.txt
-eh_logging/eh_logger.egg-info/dependency_links.txt
-eh_logging/eh_logger.egg-info/requires.txt
-eh_logging/eh_logger.egg-info/top_level.txt
-test/test.py

eh_logging/eh_logger.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

eh_logging/eh_logger.egg-info/requires.txt

@@ -1,5 +0,0 @@
-
-[dev]
-twine
-wheel
-setuptools

eh_logging/eh_logger.egg-info/top_level.txt

@@ -1 +0,0 @@
-

setup.py

@@ -12,11 +12,10 @@ setup(
     name=name,
     version=version,
     description='Simple helper to get easier formatted logger from the python logging module',
-    package_dir={'': 'eh_logging'},
-    packages=find_packages(where='eh_logging'),
+    # packages=find_packages(),
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url='https://git.eishausener.dev/Eishausener/eh-logger',
+    url='https://git.eishausener.dev/Eishausener/eh_logging',
     author=author,
     author_email='code@eishausener.de',
     license='MIT',
@@ -25,9 +24,9 @@ setup(
         'License :: OSI Approved :: MIT License',
     ],
     project_urls={
-        'issue tracker': 'https://git.eishausener.dev/Eishausener/eh-logger/issues',
+        'issue tracker': 'https://git.eishausener.dev/Eishausener/eh_logging/issues',
     },
-    install_requires=[],
+    # install_requires=[],
     extras_require={
         'dev': ['twine', 'wheel', 'setuptools'],
     }