polycubetools 1.1.0__tar.gz

polycubetools-1.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sprylos
+
+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.

polycubetools-1.1.0/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: polycubetools
+Version: 1.1.0
+Summary: Basic framework for working with polycubes in a 3-dimensional grid.
+Author: Team Polycube
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: coverage[toml]; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file
+
+# polycube-framework
+
+### Workflows
+
+These are **only** available on github, not locally
+
+1. lint workflow (runs automatically on PR, required for merging in main:
+    - runs pyright with the config in pyproject.toml (pyright strict)
+    - runs `black --check --line-length 120 "./src/polycubetools"`
+2. format workflow (can be run manually)
+    - runs `black --line-length 120 "./src/polycubetools"`
+    - commits and push to the chosen branch
+
+### Recommendations
+
+1. PyCharm IDE
+    - EAP (EARLY ACCESS PRODUCT) version: has pyright and black tools integrated
+    - alternatively: `pip install pyright black`
+
+### Getting started
+
+1. Have a look at pyproject.toml
+2. Configure a virtual environment (use python `>=3.12`)
+3. For quick testing, feel free to create a script in `scripts/`

polycubetools-1.1.0/README.md

@@ -0,0 +1,24 @@
+# polycube-framework
+
+### Workflows
+
+These are **only** available on github, not locally
+
+1. lint workflow (runs automatically on PR, required for merging in main:
+    - runs pyright with the config in pyproject.toml (pyright strict)
+    - runs `black --check --line-length 120 "./src/polycubetools"`
+2. format workflow (can be run manually)
+    - runs `black --line-length 120 "./src/polycubetools"`
+    - commits and push to the chosen branch
+
+### Recommendations
+
+1. PyCharm IDE
+    - EAP (EARLY ACCESS PRODUCT) version: has pyright and black tools integrated
+    - alternatively: `pip install pyright black`
+
+### Getting started
+
+1. Have a look at pyproject.toml
+2. Configure a virtual environment (use python `>=3.12`)
+3. For quick testing, feel free to create a script in `scripts/`

polycubetools-1.1.0/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "polycubetools"
+description = "Basic framework for working with polycubes in a 3-dimensional grid."
+readme = { file = "README.md", content-type = "text/markdown" }
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+authors = [{ name = "Team Polycube" }]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+dynamic = ["version", "dependencies"]
+
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.package-data]
+polycubetools = ["data/*.json"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["polycubetools*"]
+
+[tool.setuptools.dynamic]
+dependencies = { file = "requirements.txt" }
+
+[project.optional-dependencies]
+test = [
+    "coverage[toml]",
+    "pytest",
+    "pytest-cov",
+]
+
+[tool.pyright]
+include = [
+    "src/polycubetools",
+]
+exclude = [
+    "**/__pycache__",
+    "build",
+    "dist",
+]
+reportUnusedImport = "error"
+pythonVersion = "3.12"
+typeCheckingMode = "strict"
+
+[tool.black]
+line-length = 120
+target-version = ["py312", "py313"]

polycubetools-1.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

polycubetools-1.1.0/setup.py

@@ -0,0 +1,11 @@
+import re
+
+import setuptools
+
+
+def version():
+    with open("src/polycubetools/__init__.py") as f:
+        return re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), re.MULTILINE).group(1)  # type: ignore
+
+
+setuptools.setup(version=version())

polycubetools-1.1.0/src/polycubetools/__init__.py

@@ -0,0 +1,19 @@
+"""
+Polycube Tools
+~~~~~~~~~~~~~~~~~~~
+
+Basic framework for working with polycubes in a 3-dimensional grid.
+
+:license: MIT, see LICENSE for more details.
+"""
+
+__author__ = "Team Polycube"
+__title__ = "polycubetools"
+__license__ = "MIT"
+__version__ = "1.1.0"
+
+from . import utils as utils
+from .grid import *
+from .hull import *
+from .models import *
+from .solver import *