bs-python-utils 0.0.1__tar.gz

bs_python_utils-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023, Bernard Salanie
+
+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.

bs_python_utils-0.0.1/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.1
+Name: bs-python-utils
+Version: 0.0.1
+Summary: my Python utilities
+Home-page: https://github.com/bsalanie/bs-python-utils
+Author: Bernard Salanie
+Author-email: fbsalanie@columbia.edu
+Requires-Python: >=3.8,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: altair (>=4.2.2,<5.0.0)
+Requires-Dist: altair-saver (>=0.5.0,<0.6.0)
+Requires-Dist: matplotlib (>=3.7.1,<4.0.0)
+Requires-Dist: scikit-learn (>=1.2.2,<2.0.0)
+Requires-Dist: seaborn (>=0.12.2,<0.13.0)
+Requires-Dist: statsmodels (>=0.13.5,<0.14.0)
+Requires-Dist: vega-datasets (>=0.9.0,<0.10.0)
+Project-URL: Documentation, https://bsalanie.github.io/bs-python-utils/
+Project-URL: Repository, https://github.com/bsalanie/bs-python-utils
+Description-Content-Type: text/markdown
+
+# bs-python-utils
+
+[![Release](https://img.shields.io/github/v/release/bsalanie/bs-python-utils)](https://img.shields.io/github/v/release/bsalanie/bs-python-utils)
+[![Build status](https://img.shields.io/github/actions/workflow/status/bsalanie/bs-python-utils/main.yml?branch=main)](https://github.com/bsalanie/bs-python-utils/actions/workflows/main.yml?query=branch%3Amain)
+[![codecov](https://codecov.io/gh/bsalanie/bs-python-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/bsalanie/bs-python-utils)
+[![Commit activity](https://img.shields.io/github/commit-activity/m/bsalanie/bs-python-utils)](https://img.shields.io/github/commit-activity/m/bsalanie/bs-python-utils)
+[![License](https://img.shields.io/github/license/bsalanie/bs-python-utils)](https://img.shields.io/github/license/bsalanie/bs-python-utils)
+
+my Python utilities
+
+- **Github repository**: <https://github.com/bsalanie/bs-python-utils/>
+- **Documentation** <https://bsalanie.github.io/bs-python-utils/>
+
+## Getting started with your project
+
+First, create a repository on GitHub with the same name as this project, and then run the following commands:
+
+``` bash
+git init -b main
+git add .
+git commit -m "init commit"
+git remote add origin git@github.com:bsalanie/bs-python-utils.git
+git push -u origin main
+```
+
+Finally, install the environment and the pre-commit hooks with 
+
+```bash
+make install
+```
+
+You are now ready to start development on your project! The CI/CD
+pipeline will be triggered when you open a pull request, merge to main,
+or when you create a new release.
+
+
+## Releasing a new version
+
+<!-- - Create an API Token on [Pypi](https://pypi.org/).
+- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting 
+[this page](https://github.com/bsalanie/bs-python-utils/settings/secrets/actions/new). -->
+- Create a [new release](https://github.com/bsalanie/bs-python-utils/releases/new) on Github. 
+Create a new tag in the form ``*.*.*``.
+
+---
+
+Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).

bs_python_utils-0.0.1/README.md

@@ -0,0 +1,47 @@
+# bs-python-utils
+
+[![Release](https://img.shields.io/github/v/release/bsalanie/bs-python-utils)](https://img.shields.io/github/v/release/bsalanie/bs-python-utils)
+[![Build status](https://img.shields.io/github/actions/workflow/status/bsalanie/bs-python-utils/main.yml?branch=main)](https://github.com/bsalanie/bs-python-utils/actions/workflows/main.yml?query=branch%3Amain)
+[![codecov](https://codecov.io/gh/bsalanie/bs-python-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/bsalanie/bs-python-utils)
+[![Commit activity](https://img.shields.io/github/commit-activity/m/bsalanie/bs-python-utils)](https://img.shields.io/github/commit-activity/m/bsalanie/bs-python-utils)
+[![License](https://img.shields.io/github/license/bsalanie/bs-python-utils)](https://img.shields.io/github/license/bsalanie/bs-python-utils)
+
+my Python utilities
+
+- **Github repository**: <https://github.com/bsalanie/bs-python-utils/>
+- **Documentation** <https://bsalanie.github.io/bs-python-utils/>
+
+## Getting started with your project
+
+First, create a repository on GitHub with the same name as this project, and then run the following commands:
+
+``` bash
+git init -b main
+git add .
+git commit -m "init commit"
+git remote add origin git@github.com:bsalanie/bs-python-utils.git
+git push -u origin main
+```
+
+Finally, install the environment and the pre-commit hooks with 
+
+```bash
+make install
+```
+
+You are now ready to start development on your project! The CI/CD
+pipeline will be triggered when you open a pull request, merge to main,
+or when you create a new release.
+
+
+## Releasing a new version
+
+<!-- - Create an API Token on [Pypi](https://pypi.org/).
+- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting 
+[this page](https://github.com/bsalanie/bs-python-utils/settings/secrets/actions/new). -->
+- Create a [new release](https://github.com/bsalanie/bs-python-utils/releases/new) on Github. 
+Create a new tag in the form ``*.*.*``.
+
+---
+
+Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).

bs_python_utils-0.0.1/bs_python_utils/Timer.py

@@ -0,0 +1,76 @@
+"""
+utilities to time code
+"""
+
+import time
+from functools import wraps
+from typing import Any, Callable, Iterable
+
+
+def timeit(func: Callable) -> Callable:
+    """
+    Decorator to time a function
+    """
+
+    @wraps(func)
+    def wrapper(*args: Iterable, **kwargs: dict) -> Any:
+        start = time.perf_counter()
+        result = func(*args, **kwargs)
+        end = time.perf_counter()
+        print(f"{func.__name__} executed in {end - start:.6f} seconds")
+        return result
+
+    return wrapper
+
+
+class Timer:
+    """
+    A timer that can be started, stopped, and reset as needed by the user.
+    It keeps track of the total elapsed time in the `elapsed` attribute::
+
+       with Timer() as t:
+         ....
+       print(f"... took {t.elapsed} seconds")
+
+    use `Timer(time.process_time)` to get only CPU time.
+
+    can also do::
+
+       t = Timer()
+       t.start()
+       t.stop()
+       t.start()   # will add to the same counter
+       t.stop()
+       print(f"{t.elapsed} seconds total")
+    """
+
+    def __init__(self, func: Callable = time.perf_counter) -> None:
+        self.elapsed = 0.0
+        self._func = func
+        self._start = None
+
+    def start(self) -> None:
+        if self._start is not None:
+            raise RuntimeError("Already started")
+        self._start = self._func()
+
+    def stop(self) -> None:
+        if self._start is None:
+            raise RuntimeError("Not started")
+        end = self._func()
+        self.elapsed += end - self._start
+        self._start = None
+
+    def reset(self) -> None:
+        self.elapsed = 0.0
+
+    @property
+    def running(self) -> bool:
+        return self._start is not None
+
+    def __enter__(self) -> Any:
+        self.start()
+        return self
+
+    def __exit__(self, *args: Iterable) -> None:
+        self.stop()