onekit 0.0.0__tar.gz

onekit-0.0.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, onekit developers.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

onekit-0.0.0/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.1
+Name: onekit
+Version: 0.0.0
+Summary: One package for utility functions.
+Home-page: https://github.com/estripling/onekit
+License: BSD 3-Clause
+Keywords: onekit
+Author: onekit developers
+Requires-Python: >=3.8.1,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Project-URL: Documentation, https://onekit.readthedocs.io/en/stable/
+Project-URL: Repository, https://github.com/estripling/onekit
+Description-Content-Type: text/markdown
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/estripling/onekit/main/docs/source/_static/onekitlogo.png" width="180" alt="onekit logo.">
+</p>
+
+<p align="center">
+<a href="https://pypi.org/project/onekit"><img alt="pypi" src="https://img.shields.io/pypi/v/onekit"></a>
+<a href="https://readthedocs.org/projects/onekit/?badge=latest"><img alt="docs" src="https://readthedocs.org/projects/onekit/badge/?version=latest"></a>
+<a href="https://github.com/estripling/onekit/actions/workflows/ci.yml"><img alt="ci status" src="https://github.com/estripling/onekit/actions/workflows/ci.yml/badge.svg?branch=main"></a>
+<a href="https://codecov.io/gh/estripling/onekit"><img alt="coverage" src="https://codecov.io/github/estripling/onekit/coverage.svg?branch=main"></a>
+<a href="https://github.com/estripling/onekit/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/pypi/l/onekit"></a>
+</p>
+
+## About
+
+One package for utility functions:
+
+- [Documentation](https://onekit.readthedocs.io/en/stable/index.html)
+- [Example usage](https://onekit.readthedocs.io/en/stable/example.html)
+- [API Reference](https://onekit.readthedocs.io/en/stable/autoapi/onekit/index.html)
+
+## Installation
+
+`onekit` is available on [PyPI](https://pypi.org/project/onekit/) for Python 3.8+:
+
+```console
+pip install onekit
+```
+
+## License
+
+`onekit` was created by onekit developers.
+It is licensed under the terms of the BSD 3-Clause license.
+
+## Examples
+
+- TODO
+

onekit-0.0.0/README.md

@@ -0,0 +1,36 @@
+<p align="center">
+<img src="https://raw.githubusercontent.com/estripling/onekit/main/docs/source/_static/onekitlogo.png" width="180" alt="onekit logo.">
+</p>
+
+<p align="center">
+<a href="https://pypi.org/project/onekit"><img alt="pypi" src="https://img.shields.io/pypi/v/onekit"></a>
+<a href="https://readthedocs.org/projects/onekit/?badge=latest"><img alt="docs" src="https://readthedocs.org/projects/onekit/badge/?version=latest"></a>
+<a href="https://github.com/estripling/onekit/actions/workflows/ci.yml"><img alt="ci status" src="https://github.com/estripling/onekit/actions/workflows/ci.yml/badge.svg?branch=main"></a>
+<a href="https://codecov.io/gh/estripling/onekit"><img alt="coverage" src="https://codecov.io/github/estripling/onekit/coverage.svg?branch=main"></a>
+<a href="https://github.com/estripling/onekit/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/pypi/l/onekit"></a>
+</p>
+
+## About
+
+One package for utility functions:
+
+- [Documentation](https://onekit.readthedocs.io/en/stable/index.html)
+- [Example usage](https://onekit.readthedocs.io/en/stable/example.html)
+- [API Reference](https://onekit.readthedocs.io/en/stable/autoapi/onekit/index.html)
+
+## Installation
+
+`onekit` is available on [PyPI](https://pypi.org/project/onekit/) for Python 3.8+:
+
+```console
+pip install onekit
+```
+
+## License
+
+`onekit` was created by onekit developers.
+It is licensed under the terms of the BSD 3-Clause license.
+
+## Examples
+
+- TODO

onekit-0.0.0/pyproject.toml

@@ -0,0 +1,73 @@
+[tool.poetry]
+name = "onekit"
+version = "0.0.0"
+description = "One package for utility functions."
+authors = ["onekit developers"]
+license = "BSD 3-Clause"
+readme = "README.md"
+repository = "https://github.com/estripling/onekit"
+documentation = "https://onekit.readthedocs.io/en/stable/"
+keywords = ["onekit"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+]
+
+[tool.poetry.dependencies]
+python = ">=3.8.1,<4.0"
+
+[tool.poetry.group.precommit.dependencies]
+autoflake = "^2.2.1"
+black = {extras = ["jupyter"], version = "^23.10.1"}
+isort = "^5.12.0"
+flake8 = "^6.1.0"
+pre-commit = "^3.5.0"
+pre-commit-hooks = "^4.5.0"
+
+[tool.poetry.group.testing.dependencies]
+pytest = "^7.4.3"
+pytest-cov = "^4.1.0"
+
+[tool.poetry.group.docs.dependencies]
+furo = "^2023.9.10"
+jupyterlab = "^4.0.8"
+myst-parser = "^2.0.0"
+nbsphinx = "^0.9.3"
+sphinx-autoapi = "^3.0.0"
+sphinx-copybutton = "^0.5.2"
+time-machine = "^2.13.0"
+
+[tool.poetry.group.packaging.dependencies]
+python-semantic-release = "^8.3.0"
+
+[tool.black]
+line-length = 88
+target-version = ["py38"]
+
+[tool.isort]
+py_version = "auto"
+profile = "black"
+atomic = true
+skip_gitignore = true
+line_length = 88
+force_grid_wrap = 2
+multi_line_output = 3
+
+[tool.semantic_release]
+version_variable = "pyproject.toml:version"
+branch = "main"
+changelog_file = "CHANGELOG.md"
+build_command = "poetry build"
+dist_path = "dist/"
+upload_to_release = true
+upload_to_pypi = true
+remove_dist = false
+patch_without_tag = true
+commit_parser = "scipy"
+tag_format = "v{version}"
+
+[tool.semantic_release.remote.token]
+env = "GH_TOKEN"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

onekit-0.0.0/src/onekit/__init__.py

@@ -0,0 +1,10 @@
+from importlib import metadata
+
+__version__ = metadata.version("onekit")
+
+from .core import *
+
+del (
+    metadata,
+    core,
+)

onekit-0.0.0/src/onekit/core.py

@@ -0,0 +1,23 @@
+import inspect
+
+__all__ = ("get_function_name",)
+
+
+def get_function_name():
+    """Get name of the function when in its body.
+
+    Returns
+    -------
+    str
+        Name of the function.
+
+    Examples
+    --------
+    >>> import onekit
+    >>> def my_test_function():
+    ...     return onekit.get_function_name()
+    ...
+    >>> my_test_function()
+    'my_test_function'
+    """
+    return inspect.stack()[1].function