Skeleton

Author: davidgasquez

README.md

@@ -1,2 +1,37 @@
-# python-bufflog
-Python logger for Buffer services
+# Python Bufflog
+
+Python logger for Buffer services.
+
+## Installation
+
+You can use `pip` to install `bufflog`:
+
+```python
+pip install bufflog
+```
+
+## Usage
+
+```python
+
+import bufflog
+
+bufflog.debug('Hello debug', {"some":"stuff"});
+bufflog.info('Hello info');
+bufflog.notice('Hello notice with context', {"foo":"bar"});
+bufflog.error('Hello error');
+bufflog.critical('Hello critical');
+```
+
+## Log verbosity levels
+
+If you wish to see more logs, simply set the `LOG_LEVEL` to the desired level. Here a list with some use case:
+
+|  Levels  | Use case                                                                                                                               | Examples                                                                                                          |
+| :------: | -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
+|  DEBUG   | Information used for interactive investigation, with no long-term value. Activate it with `LOG_LEVEL=DEBUG`                            | Printing function names, steps inside a function.                                                                 |
+|   INFO   | Interesting events. Track the general flow of the application.  Activate it with `LOG_LEVEL=INFO`                                      | User logs in, SQL logs, worker process/delete a message...                                                        |
+|  NOTICE  | Uncommon events. **This is the default verbosity level**.                                                                              | Missing environment variables, page redirection, pod starting/restarting/terminating, retrying to query an API... |
+| WARNING  | Exceptional occurrences that are not errors. Undesirable things that are not necessarily wrong.                                        | Use of deprecated APIs,  poor use of an API, unauthorized access, pod restart because of memory limit ...         |
+|  ERROR   | Runtime errors. Highlight when the current flow of execution is stopped due to a failure.                                              | Exceptions messages, incorect credentials or permissions...                                                       |
+| CRITICAL | Critical conditions. Describe an unrecoverable application, system crash, or a catastrophic failure that requires immediate attention. | Application component unavailable, unexpected exception. entire website down, database unavailable ...            |

bufflog/__init__.py

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

pyproject.toml

@@ -0,0 +1,16 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="python-bufflog",
+    version="0.0.1",
+    author="David Gasquez",
+    author_email="[email protected]",
+    description="Python logger for Buffer services",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/bufferapp/python-bufflog",
+    packages=setuptools.find_packages(),
+)