neoval-py-utils 0.2.0__tar.gz

neoval_py_utils-0.2.0/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.1
+Name: neoval-py-utils
+Version: 0.2.0
+Summary: 
+Author: Neoval
+Author-email: data@neoval.io
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+
+# neoval-py-utils
+
+Python Utilities
+
+# Development
+
+All development must take place on a feature branch and a pull request is required; a user is not allowed to commit directly to `main`. The automated workflow in this repo (using `python-semantic-release`) requires the use of [angular style](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) commit messages to update the package version and `CHANGELOG`. All commits must be formatted in this way before a user is able to merge a PR; a user who may want to develop without using this format for all commits can simply squash non-angular commit messages prior to merge. A PR may only be merged by the `rebase and merge` method. This is to ensure that only angular style commits end up on `main`.
+
+Upon merge to `main`, the `deploy` workflow will facilitate the following:
+
+- bump the version in `pyproject.toml`
+- update the `CHANGELOG` using all commits added
+- tag and release, if required
+- publish to PyPi
+

neoval_py_utils-0.2.0/README.md

@@ -0,0 +1,14 @@
+# neoval-py-utils
+
+Python Utilities
+
+# Development
+
+All development must take place on a feature branch and a pull request is required; a user is not allowed to commit directly to `main`. The automated workflow in this repo (using `python-semantic-release`) requires the use of [angular style](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) commit messages to update the package version and `CHANGELOG`. All commits must be formatted in this way before a user is able to merge a PR; a user who may want to develop without using this format for all commits can simply squash non-angular commit messages prior to merge. A PR may only be merged by the `rebase and merge` method. This is to ensure that only angular style commits end up on `main`.
+
+Upon merge to `main`, the `deploy` workflow will facilitate the following:
+
+- bump the version in `pyproject.toml`
+- update the `CHANGELOG` using all commits added
+- tag and release, if required
+- publish to PyPi

neoval_py_utils-0.2.0/pyproject.toml

@@ -0,0 +1,90 @@
+[tool.poetry]
+name = "neoval-py-utils"
+version = "0.2.0"
+description = ""
+authors = ["Neoval <data@neoval.io>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+
+[tool.poetry.group.dev.dependencies]
+black = "*"
+ruff = "*"
+pytest = "*"
+taskipy = "^1.12.2"
+python-semantic-release = "^8.7.0"
+
+[tool.taskipy.tasks]
+format = "black ."
+lint = "ruff check --output-format grouped src/ tests/"
+test = "pytest tests/"
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "D", "N", "PT", "PL", "NPY", "RUF", "UP", "YTT", "ANN"]
+ignore = ["D102", "D211", "D213", "ANN101", "ANN401", "UP035"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.semantic_release]
+commit_message = "{version}\n\nAutomatically generated by python-semantic-release"
+commit_parser = "angular"
+logging_use_named_masks = false
+major_on_zero = true
+tag_format = "v{version}"
+version_toml = [
+    "pyproject.toml:tool.poetry.version",
+]
+build_command = "pip install poetry && poetry build"
+
+[tool.semantic_release.branches.main]
+match = ".*"
+prerelease_token = "rc"
+prerelease = false
+
+[tool.semantic_release.changelog]
+changelog_file = "CHANGELOG.md"
+exclude_commit_patterns = []
+
+[tool.semantic_release.changelog.environment]
+block_start_string = "{%"
+block_end_string = "%}"
+variable_start_string = "{{"
+variable_end_string = "}}"
+comment_start_string = "{#"
+comment_end_string = "#}"
+trim_blocks = false
+lstrip_blocks = false
+newline_sequence = "\n"
+keep_trailing_newline = false
+extensions = []
+autoescape = true
+
+[tool.semantic_release.commit_author]
+env = "GIT_COMMIT_AUTHOR"
+default = "semantic-release <semantic-release>"
+
+[tool.semantic_release.commit_parser_options]
+allowed_tags = ["build", "chore", "ci", "docs", "feat", "fix", "perf", "style", "refactor", "test"]
+minor_tags = ["feat"]
+patch_tags = ["fix", "perf"]
+
+[tool.semantic_release.remote]
+name = "origin"
+type = "github"
+ignore_token_for_push = false
+
+[tool.semantic_release.remote.token]
+env = "GH_TOKEN"
+
+[tool.semantic_release.publish]
+dist_glob_patterns = ["dist/*"]
+upload_to_vcs_release = true

neoval_py_utils-0.2.0/src/neoval_py_utils/__init__.py

@@ -0,0 +1 @@
+"""Python utilities for Neoval."""

neoval_py_utils-0.2.0/src/neoval_py_utils/new_util.py

@@ -0,0 +1,6 @@
+"""A test utility."""
+
+
+def test() -> None:
+    """A test."""
+    print("This is a test.")