northpole 0.0.1__tar.gz

northpole-0.0.1/.gitignore

@@ -0,0 +1 @@
+__pycache__/

northpole-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        args: ["--profile", "black", "--filter-files"]
+  - repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+      - id: black
+        language_version: python3.10
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.0.284"
+    hooks:
+      - id: ruff
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.5.0'
+    hooks:
+      - id: mypy

northpole-0.0.1/LICENSE.txt

@@ -0,0 +1,19 @@
+MIT License
+
+Copyright (c) 2023-present Stephen Lutes
+
+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.

northpole-0.0.1/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.1
+Name: northpole
+Version: 0.0.1
+Summary: Utilities to help with Advent of Code
+Project-URL: Documentation, https://github.com/stephenlutes/northpole#readme
+Project-URL: Issues, https://github.com/stephenlutes/northpole/issues
+Project-URL: Source, https://github.com/stephenlutes/northpole
+Author: Stephen Lutes
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+
+NorthPole
+==========
+
+NorthPole is a collection of utilities I develop to help in Advent of Code challenges.
+
+
+Installation
+------------
+
+``pip install northpole``
+
+
+License
+-------
+
+Northpole is distributed under the terms of the `MIT license <https://spdx.org/licenses/MIT.html>`_.

northpole-0.0.1/README.rst

@@ -0,0 +1,16 @@
+NorthPole
+==========
+
+NorthPole is a collection of utilities I develop to help in Advent of Code challenges.
+
+
+Installation
+------------
+
+``pip install northpole``
+
+
+License
+-------
+
+Northpole is distributed under the terms of the `MIT license <https://spdx.org/licenses/MIT.html>`_.

northpole-0.0.1/northpole.code-workspace

@@ -0,0 +1,13 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {
+		"files.exclude": {
+			".mypy_cache": true,
+			".ruff_cache": true
+		}
+	}
+}

northpole-0.0.1/pyproject.toml

@@ -0,0 +1,157 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "northpole"
+dynamic = ["version"]
+description = "Utilities to help with Advent of Code"
+readme = "README.rst"
+requires-python = ">=3.8"
+license = "MIT"
+keywords = []
+authors = [
+  { name = "Stephen Lutes" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = []
+
+[project.urls]
+Documentation = "https://github.com/stephenlutes/northpole#readme"
+Issues = "https://github.com/stephenlutes/northpole/issues"
+Source = "https://github.com/stephenlutes/northpole"
+
+[tool.hatch.version]
+path = "src/northpole/__about__.py"
+
+[tool.hatch.envs.default]
+dependencies = [
+  "coverage[toml]>=6.5",
+  "pytest",
+]
+[tool.hatch.envs.default.scripts]
+test = "pytest {args:tests}"
+test-cov = "coverage run -m pytest {args:tests}"
+cov-report = [
+  "- coverage combine",
+  "coverage report",
+]
+cov = [
+  "test-cov",
+  "cov-report",
+]
+
+[[tool.hatch.envs.all.matrix]]
+python = ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+[tool.hatch.envs.lint]
+detached = true
+dependencies = [
+  "black>=23.1.0",
+  "mypy>=1.0.0",
+  "ruff>=0.0.243",
+]
+[tool.hatch.envs.lint.scripts]
+typing = "mypy --install-types --non-interactive {args:src/northpole tests}"
+style = [
+  "ruff {args:.}",
+  "black --check --diff {args:.}",
+]
+fmt = [
+  "black {args:.}",
+  "ruff --fix {args:.}",
+  "style",
+]
+all = [
+  "style",
+  "typing",
+]
+
+[tool.black]
+target-version = ["py37"]
+line-length = 120
+skip-string-normalization = true
+
+[tool.ruff]
+target-version = "py37"
+line-length = 120
+select = [
+  "A",
+  "ARG",
+  "B",
+  "C",
+  "DTZ",
+  "E",
+  "EM",
+  "F",
+  "FBT",
+  "I",
+  "ICN",
+  "ISC",
+  "N",
+  "PLC",
+  "PLE",
+  "PLR",
+  "PLW",
+  "Q",
+  "RUF",
+  "S",
+  "T",
+  "TID",
+  "UP",
+  "W",
+  "YTT",
+]
+ignore = [
+  # Allow non-abstract empty methods in abstract base classes
+  "B027",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Ignore checks for possible passwords
+  "S105", "S106", "S107",
+  # Ignore complexity
+  "C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915",
+]
+unfixable = [
+  # Don't touch unused imports
+  "F401",
+]
+
+[tool.ruff.isort]
+known-first-party = ["northpole"]
+
+[tool.ruff.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[tool.ruff.per-file-ignores]
+# Tests can use magic values, assertions, and relative imports
+"tests/**/*" = ["PLR2004", "S101", "TID252"]
+
+[tool.coverage.run]
+source_pkgs = ["northpole", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/northpole/__about__.py",
+]
+
+[tool.coverage.paths]
+northpole = ["src/northpole", "*/northpole/src/northpole"]
+tests = ["tests", "*/northpole/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]

northpole-0.0.1/src/northpole/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

northpole-0.0.1/src/northpole/parsers.py

@@ -0,0 +1,14 @@
+def parse_string(data: str) -> str:
+    """
+    Parse the input (most likely read from a file) into a single string. The input data
+    will be split on new line characters, and the first string will be returned. It
+    works on the assumption that while there may be a new line character in the input,
+    there is nothing after it.
+
+    Args:
+        data (str): The input data to parse.
+
+    Returns:
+        str: The string from before the first new line character.
+    """
+    return data.splitlines()[0]

northpole-0.0.1/tests/test_parsers.py

@@ -0,0 +1,10 @@
+import pytest
+
+from northpole.parsers import parse_string
+
+
+@pytest.mark.parametrize("expected,suffix", [("Santa", "\n"), ("Santa", "\nClause"), ("Santa", "")])
+def test_parse_string(expected: str, suffix: str) -> None:
+    data: str = f"{expected}{suffix}"
+
+    assert parse_string(data) == expected