tikzpics 0.1__tar.gz

tikzpics-0.1/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: tikzpics
+Version: 0.1
+Summary: Python interface to generate (readable) Tikz figures.
+Author: Max
+Project-URL: Source, https://github.com/max-models/tikzpics
+Keywords: python
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: pymupdf
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Provides-Extra: dev
+Requires-Dist: tikzpics[test]; extra == "dev"
+Requires-Dist: black[jupyter]; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pyproject-fmt; extra == "dev"
+Requires-Dist: jupyterlab; extra == "dev"
+Requires-Dist: ipykernel; extra == "dev"
+Requires-Dist: numpy; extra == "dev"
+Requires-Dist: scipy; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: nbconvert; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx_bootstrap_theme; extra == "docs"
+
+# tikzpics
+
+Python interface to generate (readable) Tikz figures.
+
+Documentation: https://max-models.github.io/tikzpics/
+
+# Install
+
+Create and activate python environment
+
+```
+python -m venv env
+source env/bin/activate
+pip install --upgrade pip
+```
+
+Install the code and requirements with pip
+
+```
+pip install -e .
+```
+
+To install optional dependencies:
+
+```
+pip install -e ".[test]" # For pytest
+pip install -e ".[dev]" For developers
+```

tikzpics-0.1/README.md

@@ -0,0 +1,28 @@
+# tikzpics
+
+Python interface to generate (readable) Tikz figures.
+
+Documentation: https://max-models.github.io/tikzpics/
+
+# Install
+
+Create and activate python environment
+
+```
+python -m venv env
+source env/bin/activate
+pip install --upgrade pip
+```
+
+Install the code and requirements with pip
+
+```
+pip install -e .
+```
+
+To install optional dependencies:
+
+```
+pip install -e ".[test]" # For pytest
+pip install -e ".[dev]" For developers
+```

tikzpics-0.1/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tikzpics"
+version = "0.1"
+description = "Python interface to generate (readable) Tikz figures."
+readme = "README.md"
+requires-python = ">=3.8"
+license = {file = "LICENSE.txt"}
+keywords = ["python"]
+authors = [{name = "Max"}]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+]
+dependencies = [
+    "pymupdf",
+]
+
+[project.optional-dependencies]
+
+test = [
+    "pytest",
+    "coverage",
+]
+
+dev = [
+    "tikzpics[test]",
+    "black[jupyter]",
+    "isort",
+    "ruff",
+    "pre-commit",
+    "pyproject-fmt",
+    "jupyterlab",
+    "ipykernel",
+    "numpy",
+    "scipy",
+]
+
+# https://medium.com/@pratikdomadiya123/build-project-documentation-quickly-with-the-sphinx-python-2a9732b66594
+docs = [
+  "myst-parser",
+  "nbconvert",
+  "nbsphinx",
+  "sphinx",
+  "sphinx_bootstrap_theme",
+]
+
+[project.urls]
+"Source" = "https://github.com/max-models/tikzpics"
+
+[tool.setuptools.packages.find]
+where = ["src"]

tikzpics-0.1/setup.cfg

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

tikzpics-0.1/src/tikzpics/__init__.py

@@ -0,0 +1,4 @@
+from tikzpics.figure import TikzFigure
+from tikzpics.node import Node
+
+__all__ = ["TikzFigure", "Node"]

tikzpics-0.1/src/tikzpics/base.py

@@ -0,0 +1,55 @@
+class TikzObject:
+    def __init__(
+        self,
+        label: str | None = None,
+        comment: str | None = None,
+        layer: int | None = 0,
+        options: list | None = None,
+        **kwargs,
+    ) -> None:
+
+        if options is None:
+            options = []
+
+        self._label = label
+        self._comment = comment
+        self._layer = layer
+        self._options = options
+        self._kwargs = kwargs
+
+    @property
+    def label(self) -> str | None:
+        return self._label
+
+    @property
+    def comment(self) -> str | None:
+        return self._comment
+
+    @property
+    def layer(self) -> int:
+        return self._layer
+
+    @property
+    def options(self) -> list:
+        return self._options
+
+    @property
+    def kwargs(self) -> dict:
+        return self._kwargs
+
+    @property
+    def tikz_options(self) -> str:
+        if len(self.options) == 0:
+            options = ""
+        else:
+            options = ", ".join(self.options) + ", "
+
+        options += ", ".join(
+            f"{k.replace('_', ' ')}={v}" for k, v in self.kwargs.items()
+        )
+        return options
+
+    def add_comment(self, string_in) -> str:
+        if self.comment is not None:
+            return f"\n% {self.comment}\n{string_in}"
+        return string_in

tikzpics-0.1/src/tikzpics/color.py

@@ -0,0 +1,14 @@
+class Color:
+    def __init__(self, color_spec):
+        """
+        Initialize the Color object by parsing the color specification.
+
+        Parameters:
+        - color_spec: Can be a TikZ color string (e.g., 'blue!20'), a standard color name,
+                      an RGB tuple, a hex code, etc.
+        """
+        self._color_spec = color_spec
+
+    @property
+    def color_spec(self):
+        return self._color_spec

tikzpics-0.1/src/tikzpics/console/main.py

@@ -0,0 +1,6 @@
+def main():
+    print("Welcome to tikzpics!")
+
+
+if __name__ == "__main__":
+    main()

tikzpics-0.1/src/tikzpics/coordinate.py

@@ -0,0 +1,43 @@
+from tikzpics.base import TikzObject
+
+
+class TikzCoordinate(TikzObject):
+    def __init__(
+        self,
+        x: float,
+        y: float,
+        z: float | None = None,
+        layer: int = 0,
+    ) -> None:
+        super().__init__(layer=layer, comment=None)
+
+        self._x = x
+        self._y = y
+        self._z = z
+        if z is None:
+            self._ndim = 2
+        else:
+            self._ndim = 3
+
+    @property
+    def x(self):
+        return self._x
+
+    @property
+    def y(self):
+        return self._y
+
+    @property
+    def z(self):
+        return self._z
+
+    @property
+    def coordinate(self):
+        if self.ndim == 2:
+            return ((self.x), self.y)
+        else:
+            return (self.x, self.y, self.z)
+
+    @property
+    def ndim(self):
+        return self._ndim