orval 0.0.1__tar.gz

orval-0.0.1/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.1
+Name: orval
+Version: 0.0.1
+Summary: A Python package that contains a small set of convenient python functions
+Home-page: https://github.com/lukin0110/orval/
+License: Proprietary
+Requires-Python: >=3.13.0,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Project-URL: Repository, https://github.com/lukin0110/orval/
+Description-Content-Type: text/markdown
+
+[![Lint and Test](https://github.com/lukin0110/orval/actions/workflows/test.yml/badge.svg)](https://github.com/lukin0110/orval/actions)
+
+# Orval
+
+A Python package that contains a small set of convenient python functions.
+
+## 🚀 Using
+
+To install this package, run:
+```bash
+pip install orval
+```
+
+
+## 🧑‍💻 Contributing
+
+<details>
+<summary>Prerequisites</summary>
+
+<details>
+<summary>1. Install Docker</summary>
+
+1. Go to [Docker](https://www.docker.com/get-started), download and install docker.
+2. [Configure Docker to use the BuildKit build system](https://docs.docker.com/build/buildkit/#getting-started). On macOS and Windows, BuildKit is enabled by default in Docker Desktop.
+
+</details>
+
+<details>
+<summary>2. Install VS Code</summary>
+
+Go to [VS Code](https://code.visualstudio.com/), download and install VS Code.
+</details>
+
+
+</details>
+
+#### 1. Open DevContainer with VS Code
+Open this repository with VS Code, and run <kbd>Ctrl/⌘</kbd> + <kbd>⇧</kbd> + <kbd>P</kbd> → _Dev Containers: Reopen in Container_.
+
+The following commands can be used inside a DevContainer.
+
+#### 2. Run linters
+```bash
+poe lint
+```
+
+#### 3. Run tests
+```bash
+poe test
+```
+
+#### 4. Update poetry lock file
+```bash
+poetry lock --no-update
+```
+
+---
+See how to develop with [PyCharm or any other IDE](https://github.com/lukin0110/poetry-copier/tree/main/docs/ide.md).
+
+---
+️⚡️ Scaffolded with [Poetry Copier](https://github.com/lukin0110/poetry-copier/).\
+🛠️ [Open an issue](https://github.com/lukin0110/poetry-copier/issues/new) if you have any questions or suggestions.
+

orval-0.0.1/README.md

@@ -0,0 +1,62 @@
+[![Lint and Test](https://github.com/lukin0110/orval/actions/workflows/test.yml/badge.svg)](https://github.com/lukin0110/orval/actions)
+
+# Orval
+
+A Python package that contains a small set of convenient python functions.
+
+## 🚀 Using
+
+To install this package, run:
+```bash
+pip install orval
+```
+
+
+## 🧑‍💻 Contributing
+
+<details>
+<summary>Prerequisites</summary>
+
+<details>
+<summary>1. Install Docker</summary>
+
+1. Go to [Docker](https://www.docker.com/get-started), download and install docker.
+2. [Configure Docker to use the BuildKit build system](https://docs.docker.com/build/buildkit/#getting-started). On macOS and Windows, BuildKit is enabled by default in Docker Desktop.
+
+</details>
+
+<details>
+<summary>2. Install VS Code</summary>
+
+Go to [VS Code](https://code.visualstudio.com/), download and install VS Code.
+</details>
+
+
+</details>
+
+#### 1. Open DevContainer with VS Code
+Open this repository with VS Code, and run <kbd>Ctrl/⌘</kbd> + <kbd>⇧</kbd> + <kbd>P</kbd> → _Dev Containers: Reopen in Container_.
+
+The following commands can be used inside a DevContainer.
+
+#### 2. Run linters
+```bash
+poe lint
+```
+
+#### 3. Run tests
+```bash
+poe test
+```
+
+#### 4. Update poetry lock file
+```bash
+poetry lock --no-update
+```
+
+---
+See how to develop with [PyCharm or any other IDE](https://github.com/lukin0110/poetry-copier/tree/main/docs/ide.md).
+
+---
+️⚡️ Scaffolded with [Poetry Copier](https://github.com/lukin0110/poetry-copier/).\
+🛠️ [Open an issue](https://github.com/lukin0110/poetry-copier/issues/new) if you have any questions or suggestions.

orval-0.0.1/pyproject.toml

@@ -0,0 +1,137 @@
+[tool.poetry]  # https://python-poetry.org/docs/pyproject/
+name = "orval"
+version = "0.0.1"
+description = "A Python package that contains a small set of convenient python functions"
+authors = []
+license = "Proprietary"
+readme = "README.md"
+repository = "https://github.com/lukin0110/orval/"
+
+[build-system]  # https://python-poetry.org/docs/pyproject/#poetry-and-pep-517
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.dependencies]  # https://python-poetry.org/docs/dependency-specification/
+python = ">=3.13.0,<4.0"
+
+[tool.poetry.group.dev.dependencies]  # https://python-poetry.org/docs/master/managing-dependencies/
+coverage = { extras = ["toml"], version = ">=7.4.1" }
+ipython = ">=8.29.0"
+mypy = "1.13.0"
+poethepoet = ">=0.29.0"
+pre-commit = ">=4.0.1"
+pytest = ">=8.3.3"
+pytest-clarity = ">=1.0.1"
+pytest-mock = ">=3.14.0"
+ruff = ">=0.7.2"
+safety = ">=2.3.5,!=2.3.5"
+shellcheck-py = ">=0.10.0"
+typeguard = ">=4.4.1"
+
+[[tool.poetry.source]]  # https://python-poetry.org/docs/repositories/
+name = "pypi"
+priority = "primary"
+
+[tool.coverage.report]  # https://coverage.readthedocs.io/en/latest/config.html#report
+# TODO: please raise the bar :)
+fail_under = 0
+precision = 1
+show_missing = true
+skip_covered = true
+
+[tool.coverage.run]  # https://coverage.readthedocs.io/en/latest/config.html#run
+branch = true
+command_line = "--module pytest"
+data_file = "reports/.coverage"
+source = ["src"]
+
+[tool.coverage.xml]  # https://coverage.readthedocs.io/en/latest/config.html#xml
+output = "reports/coverage.xml"
+
+[tool.mypy]  # https://mypy.readthedocs.io/en/latest/config_file.html
+junit_xml = "reports/mypy.xml"
+strict = true
+disallow_subclassing_any = false
+disallow_untyped_decorators = false
+explicit_package_bases = true
+ignore_missing_imports = true
+pretty = true
+show_column_numbers = true
+show_error_codes = true
+show_error_context = true
+warn_unreachable = true
+mypy_path = "src"
+
+[tool.pytest.ini_options]  # https://docs.pytest.org/en/latest/reference/reference.html#ini-options-ref
+addopts = "--color=yes --doctest-modules --exitfirst --failed-first --strict-config --strict-markers --typeguard-packages=orval --verbosity=2 --junitxml=reports/pytest.xml"
+filterwarnings = ["error", "ignore::DeprecationWarning"]
+testpaths = ["src", "tests"]
+xfail_strict = true
+log_file_level = "info"
+pythonpath = "src"
+
+[tool.ruff]  # https://github.com/charliermarsh/ruff
+fix = true
+line-length = 120
+src = ["src", "tests"]
+target-version = "py313"
+force-exclude = true  # https://docs.astral.sh/ruff/settings/#force-exclude
+preview = true  # https://docs.astral.sh/ruff/preview/
+
+[tool.ruff.lint]  # https://github.com/charliermarsh/ruff
+ignore = ["FBT002", "G004", "D203", "D213", "E501", "EM101", "EM102", "FBT001", "ISC001", "RET504", "S101", "TRY003", "TRY300", "W505"]
+select = ["A", "ASYNC", "B", "BLE", "C4", "C90", "D", "DTZ", "E", "EM", "ERA", "F", "FBT", "FLY", "FURB", "G", "I", "ICN", "INP", "INT", "ISC", "LOG", "N", "NPY", "PERF", "PGH", "PIE", "PLC", "PLE", "PLR", "PLW", "PT", "PTH", "PYI", "RET", "RSE", "RUF", "S", "SIM", "SLF", "SLOT", "T10", "T20", "TCH", "TID", "TRY", "UP", "W", "YTT"]
+unfixable = ["ERA001", "F401", "F841", "T201", "T203"]  # https://docs.astral.sh/ruff/settings/#unfixable
+
+[tool.ruff.lint.extend-per-file-ignores] # https://docs.astral.sh/ruff/settings/#extend-per-file-ignores
+# Ignore missing __init__.py files in tests.
+"tests/*" = ["INP001", "PLR2004"]
+
+[tool.ruff.lint.flake8-tidy-imports]
+# Disallow all relative imports.
+ban-relative-imports = "all"
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.ruff.lint.pep8-naming]
+# Allow Pydantic's `@validator` decorator to trigger class method treatment.
+classmethod-decorators = ["classmethod", "pydantic.validator", "pydantic.root_validator"]
+
+[tool.ruff.lint.pycodestyle]
+max-doc-length = 100
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.poe.tasks] # https://poethepoet.natn.io/index.html
+    [tool.poe.tasks.lint]
+    help = "Lint this package"
+
+    [[tool.poe.tasks.lint.sequence]]
+    shell = '[ -d ".git" ] || { echo "\n\\033[0;31mGit is not initialized in this directory. Please run \"git init\" to fix linting.\\033[0m\n"; exit 1; }'
+
+    [[tool.poe.tasks.lint.sequence]]
+    cmd = """
+    pre-commit run
+        --all-files
+        --color always
+    """
+
+
+    [tool.poe.tasks.safety]
+    help = "Run safety checks on this package"
+    shell = "safety check --continue-on-error --full-report"
+
+
+    [tool.poe.tasks.test]
+    help = "Test this package"
+
+    [[tool.poe.tasks.test.sequence]]
+    cmd = "coverage run"
+
+    [[tool.poe.tasks.test.sequence]]
+    cmd = "coverage report"
+
+    [[tool.poe.tasks.test.sequence]]
+    cmd = "coverage xml"

orval-0.0.1/src/orval/__init__.py

@@ -0,0 +1,15 @@
+"""Orval package."""
+
+from orval.datetimes import utcnow
+from orval.strings import camel_case, kebab_case, pascal_case, slugify, snake_case
+from orval.utils import timing
+
+__all__ = [
+    "camel_case",
+    "kebab_case",
+    "pascal_case",
+    "slugify",
+    "snake_case",
+    "timing",
+    "utcnow",
+]

orval-0.0.1/src/orval/arrays.py

@@ -0,0 +1,12 @@
+"""Array utilities."""
+
+from typing import TypeVar
+
+T = TypeVar("T")
+
+
+def chunkify(seq: list[T], s: int) -> list[list[T]]:
+    """Break a list into chunks of size S."""
+    if s < 1:
+        raise ValueError(f"Size must be > 0, invalid value {s}")
+    return [seq[pos : pos + s] for pos in range(0, len(seq), s)]

orval-0.0.1/src/orval/datetimes.py

@@ -0,0 +1,12 @@
+"""Datetime utilities."""
+
+import datetime
+
+
+def utcnow() -> datetime.datetime:
+    """Generate now as a datetime with UTC time zone info.
+
+    The `datetime.datetime.utcnow()` function from the standard library does not include time zone information by
+    default. https://docs.python.org/3/library/datetime.html#datetime.datetime.now
+    """
+    return datetime.datetime.now(tz=datetime.UTC)

orval-0.0.1/src/orval/strings.py

@@ -0,0 +1,61 @@
+"""String utilities."""
+
+import re
+import unicodedata
+
+
+def slugify(value: str, allow_unicode: bool = False) -> str:
+    """Create a slug from a given string.
+
+    Normalize strings to a 'slug'. Can be used to format URL's or resource names (eg: Database name).
+
+    Convert to ASCII if 'allow_unicode' is False.
+    Convert any single or consecutive spaces, dots or hyphens to a single hyphen.
+    Remove characters that aren't alphanumerics, underscores, or hyphens.
+    Convert to lowercase.
+    Strip leading and trailing whitespace.
+
+    Parameters
+    ----------
+    value
+        Input string to transform.
+    allow_unicode
+        The output may contain unicode characters.
+
+    Returns
+    -------
+    str
+        Returns a transformed string.
+    """
+    if allow_unicode:
+        value = unicodedata.normalize("NFKC", value)
+    else:
+        value = unicodedata.normalize("NFKD", value).encode("ascii", "ignore").decode("ascii")
+    value = re.sub(r"[^\w\s\-.]", "", value).strip().lower()
+    return re.sub(r"[\s\-.]+", "-", value)
+
+
+def camel_case(string: str) -> str:
+    """Convert a string to camelCase."""
+    input_ = string.strip()
+    words = input_.split(" ")
+    camel_case_words = [words[0].lower()] + [word.capitalize() for word in words[1:]]
+    return "".join(camel_case_words)
+
+
+def kebab_case(string: str) -> str:
+    """Convert a string to kebab-case."""
+    input_ = string.strip().lower()
+    return input_.replace(" ", "-")
+
+
+def pascal_case(string: str) -> str:
+    """Convert a string to PascalCase."""
+    words = string.split()
+    return "".join(word.capitalize() for word in words)
+
+
+def snake_case(string: str) -> str:
+    """Convert a string to snake_case."""
+    input_ = string.strip().lower()
+    return input_.replace(" ", "_")

orval-0.0.1/src/orval/utils.py

@@ -0,0 +1,43 @@
+"""Utilities."""
+
+import logging
+import time
+from collections.abc import Callable
+from functools import partial
+from typing import Any, TypeVar
+
+R = TypeVar("R")
+
+
+def timing(func: Callable[..., R] | None = None, level: int = logging.INFO) -> Any:
+    """Log the elapsed time of a function.
+
+    Decorator can be used with or without arguments. Eg: `@timing` or `@timing(level=logging.DEBUG)`.
+
+    Parameters
+    ----------
+    func
+        The wrapped function to log the elapsed time of.
+    level
+        Log level to user. Default: INFO.
+
+    Returns
+    -------
+    Any
+        The function wrapped to log timing.
+    """
+    if func is None:
+        return partial(timing, level=level)
+
+    def wrapper(
+        *args: list[Any],
+        **kwargs: dict[str, Any],
+    ) -> Any:
+        """Log elapsed time of the wrapped function."""
+        start = time.perf_counter()
+        result = func(*args, **kwargs)
+        end = time.perf_counter()
+        logging.getLogger(__name__).log(level, f"Timing for '{func.__name__}': {end - start:.3f}s")
+        return result
+
+    return wrapper