offset-poly 0.1.0__tar.gz → 0.3.0__tar.gz

offset-poly-0.3.0/.pre-commit-config.yaml

@@ -0,0 +1,140 @@
+ci:
+  skip: [pyright]
+
+exclude: "tests"
+
+repos:
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+    - id: check-added-large-files
+    - id: check-ast
+    - id: check-case-conflict
+    - id: check-docstring-first
+    - id: check-executables-have-shebangs
+    - id: check-json
+    - id: check-merge-conflict
+      args:
+        - --assume-in-merge
+    - id: check-shebang-scripts-are-executable
+    - id: check-symlinks
+    - id: check-toml
+    - id: check-vcs-permalinks
+    - id: check-xml
+    - id: check-yaml
+    - id: debug-statements
+    - id: destroyed-symlinks
+    - id: detect-aws-credentials
+    - id: detect-private-key
+    - id: end-of-file-fixer
+    - id: mixed-line-ending
+    - id: requirements-txt-fixer
+    - id: trailing-whitespace
+    - id: fix-encoding-pragma
+      args:
+      - --remove
+    - id: name-tests-test
+      args:
+      - --pytest-test-first
+    - id: no-commit-to-branch
+    - id: pretty-format-json
+    # - id: sort-simple-yaml
+        # files: .pre-commit-config.yaml
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.5.1
+  hooks:
+  - id: mypy
+    name: mypy
+    language: python
+    language_version: python 3.11
+    types: [python]
+    require_serial: true
+    verbose: true
+    additional_dependencies: ['types-requests']
+    # exclude: "tests"
+    # args:
+    # - --ignore-missing-imports
+    # files: ^(src/|tests/)
+
+- repo: https://github.com/PyCQA/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
+    args: ["--profile", "black", "--filter-files", "--combine-as"]
+
+- repo: https://github.com/psf/black
+  rev: 23.7.0
+  hooks:
+  - id: black
+    language_version: python3.9
+    args: ["--skip-magic-trailing-comma"]
+
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.10.1
+  hooks:
+  - args:
+    - --py39-plus
+    id: pyupgrade
+
+- repo: https://github.com/Lucas-C/pre-commit-hooks
+  rev: v1.5.4
+  hooks:
+  - id: remove-tabs
+
+# - repo: https://github.com/commitizen-tools/commitizen
+#   rev: v2.40.0
+#   hooks:
+#   - id: commitizen
+
+- repo: https://github.com/pre-commit/mirrors-pylint
+  rev: v3.0.0a5
+  hooks:
+  - id: pylint
+    exclude: "tests"
+    name: pylint
+    args:
+    - --good-names=i,j,_,f
+    - --disable=protected-access
+    - --disable=no-member
+    - --disable=import-error
+    - --disable=no-name-in-module
+    - --disable=missing-return-doc
+    - --load-plugins=pylint.extensions.docparams
+    - --accept-no-param-doc=n
+    - --accept-no-raise-doc=n
+    - --accept-no-return-doc=n
+    - --accept-no-yields-doc=n
+
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  # ignores
+  # ANN101 Missing type annotation for self in method
+  # ANN102 Missing type annotation for cls in classmethod
+  # ANN201 Missing return type annotation for public function
+  # ANN202 Missing return type annotation for private function (wants -> None everywhere)
+  # B905 zip() without an explicit strict= parameter
+  # COM812 Trailing comma missing
+  # D203 1 blank line required before class docstring
+  # D213 multi line summary second line
+  # I001 Inport block is un-sorted or un-formatted
+  # ISC003 Explicitly concatenated string should be implicitly concatenated
+  # N802 Function name should be lowercase
+  # N806 Variable in function should be lowercase
+  # PGH003 Use specific rule codes when ignoring type issues
+  # PLR0913 Too many arguments to function call
+  # PTH108 os.unlink should be replaced by .unlink()
+  rev: 'v0.0.285'
+  hooks:
+    - id: ruff
+      exclude: "tests"
+      args:
+      - --select=ALL
+      - --ignore=ANN101,ANN102,ANN201,ANN202,B905,COM812,D203,D213,I001,ISC003,N802,N806,PGH003,PLR0913,PTH108
+      - --fix
+
+# reads pyproject.toml for additional config
+- repo: https://github.com/RobertCraigie/pyright-python
+  rev: v1.1.324
+  hooks:
+    - id: pyright

{offset_poly-0.1.0 → offset-poly-0.3.0}/PKG-INFO

@@ -1,55 +1,52 @@
-Metadata-Version: 2.1
-Name: offset-poly
-Version: 0.1.0
-Summary: 
-Author: Shay Hill
-Author-email: shay_public@hotmail.com
-Requires-Python: >=3.9,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Description-Content-Type: text/markdown
-
-# offset_poly
-
-Move a polyline or polygon (left) by a given offset.
-
-A counterclockwise polygon will be offset to the inside. I clockwise polygon will be offset to the outside.
-
-## offset_polygon
-
-~~~python
-def offset_polygon(polyline: Sequence[_Vec2], offset: float) -> list[_Vec2]:
-    """Offset polygon edges (to the left) by a constant amount.
-
-    :param polyline: polyline
-    :param offset: distance to offset from each edge
-    :return: polygon offset by offset
-    """
-~~~
-
-## offset_polyline
-
-~~~python
-def offset_polyline(polyline: Sequence[_Vec2], offset: float) -> list[_Vec2]:
-    """Offset polygon edges (to the left) by a constant amount.
-
-    :param polyline: polyline
-    :param offset: distance to offset from each edge
-    :return: polyline offset by offset
-    """
-~~~
-
-The difference between the two is that `offset_polygon` will close the polygon if it is not already closed, whereas `offset_polyline` will leave the polyline open even if the first and last points are identical.
-
-This package is the simplest version of polyline offsetting, it does not anticipate or account for self intersections that may come up when offsetting a polyline.
-
-This is not nearly as sophisticated as curve offsetting, but you can use this for control polygon offsetting, which will be nearly as good in some instances.
-
-* multiple points (knots in your control points) are preserved.
-* if input[0] == input[-1], output[0] will equal output[-1]
-
-## You may see (nan, nan) in the result.
-
-If you pass two adjacent, opposite, parallel edges, you will get a (nan, nan) in the result. With points A -> B -> A, for instance, there is no point that would be any given distance (except 0) left of both A B and B A.
+Metadata-Version: 2.1
+Name: offset-poly
+Version: 0.3.0
+Summary: offset a polyline or polygon in 2D space
+Author-email: Shay Hill <shay_public@hotmail.com>
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+
+# offset_poly
+
+Move a polyline or polygon (left) by a given offset.
+
+A counterclockwise polygon will be offset to the inside. I clockwise polygon will be offset to the outside.
+
+## offset_polygon
+
+~~~python
+def offset_polygon(polyline: Sequence[_Vec2], offset: float) -> list[_Vec2]:
+    """Offset polygon edges (to the left) by a constant amount.
+
+    :param polyline: polyline
+    :param offset: distance to offset from each edge
+    :return: polygon offset by offset
+    """
+~~~
+
+## offset_polyline
+
+~~~python
+def offset_polyline(polyline: Sequence[_Vec2], offset: float) -> list[_Vec2]:
+    """Offset polygon edges (to the left) by a constant amount.
+
+    :param polyline: polyline
+    :param offset: distance to offset from each edge
+    :return: polyline offset by offset
+    """
+~~~
+
+The difference between the two is that `offset_polygon` will close the polygon if it is not already closed, whereas `offset_polyline` will leave the polyline open even if the first and last points are identical.
+
+This package is the simplest version of polyline offsetting, it does not anticipate or account for self intersections that may come up when offsetting a polyline.
+
+This is not nearly as sophisticated as curve offsetting, but you can use this for control polygon offsetting, which will be nearly as good in some instances.
+
+* multiple points (knots in your control points) are preserved.
+* if input[0] == input[-1], output[0] will equal output[-1]
+
+## You may see (nan, nan) in the result.
+
+If you pass two adjacent, opposite, parallel edges, you will get a (nan, nan) in the result. With points A -> B -> A, for instance, there is no point that would be any given distance (except 0) left of both A B and B A.

{offset_poly-0.1.0 → offset-poly-0.3.0}/README.md

@@ -39,4 +39,4 @@ This is not nearly as sophisticated as curve offsetting, but you can use this fo
 
 ## You may see (nan, nan) in the result.
 
-If you pass two adjacent, opposite, parallel edges, you will get a (nan, nan) in the result. With points A -> B -> A, for instance, there is no point that would be any given distance (except 0) left of both A B and B A.
+If you pass two adjacent, opposite, parallel edges, you will get a (nan, nan) in the result. With points A -> B -> A, for instance, there is no point that would be any given distance (except 0) left of both A B and B A.