pd-code-mirror 0.1.0__tar.gz → 0.1.1__tar.gz

pd_code_mirror-0.1.1/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: pd-code-mirror
+Version: 0.1.1
+Summary: # pd_code_mirror
+License: MIT
+License-File: LICENSE
+Author: mirror a link or knot with pd_code.
+Requires-Python: >=3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: pd-code-sanity (>=0.1.0)
+Description-Content-Type: text/markdown
+
+# pd-code-mirror
+
+Construct the mirror image of a knot or link represented by a PD code.
+
+## Installation
+
+```bash
+pip install pd-code-mirror
+```
+
+## Usage example
+
+```python
+from pd_code_mirror import mirror_pd_code
+
+pd = [[1, 5, 2, 4], [3, 1, 4, 6], [5, 3, 6, 2]]
+print(mirror_pd_code(pd))
+```
+
+## Algorithm
+
+Mirroring reverses the cyclic crossing order while keeping the first slot fixed: `[a,b,c,d]` becomes `[a,d,c,b]`. This switches over/under crossing information without changing arc incidences. The input and output are structurally validated, and the caller's list is not mutated.
+
+## Input conventions
+
+A PD code is represented as a list of four-entry crossings. Arc labels normally occur exactly twice. Public functions validate inputs and return new values rather than mutating caller-owned data unless their API explicitly says otherwise.
+
+## External software
+
+No external software is required.
+
+## Development
+
+Run examples and package checks before release. Python packages require Python 3.10 or newer. Build PyPI artifacts with:
+
+```bash
+poetry check
+poetry build
+```
+
+## License
+
+MIT. See `LICENSE`.
+

pd_code_mirror-0.1.1/README.md

@@ -0,0 +1,43 @@
+# pd-code-mirror
+
+Construct the mirror image of a knot or link represented by a PD code.
+
+## Installation
+
+```bash
+pip install pd-code-mirror
+```
+
+## Usage example
+
+```python
+from pd_code_mirror import mirror_pd_code
+
+pd = [[1, 5, 2, 4], [3, 1, 4, 6], [5, 3, 6, 2]]
+print(mirror_pd_code(pd))
+```
+
+## Algorithm
+
+Mirroring reverses the cyclic crossing order while keeping the first slot fixed: `[a,b,c,d]` becomes `[a,d,c,b]`. This switches over/under crossing information without changing arc incidences. The input and output are structurally validated, and the caller's list is not mutated.
+
+## Input conventions
+
+A PD code is represented as a list of four-entry crossings. Arc labels normally occur exactly twice. Public functions validate inputs and return new values rather than mutating caller-owned data unless their API explicitly says otherwise.
+
+## External software
+
+No external software is required.
+
+## Development
+
+Run examples and package checks before release. Python packages require Python 3.10 or newer. Build PyPI artifacts with:
+
+```bash
+poetry check
+poetry build
+```
+
+## License
+
+MIT. See `LICENSE`.

{pd_code_mirror-0.1.0 → pd_code_mirror-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pd-code-mirror"
-version = "0.1.0"
+version = "0.1.1"
 description = "# pd_code_mirror"
 authors = [
     {name = "mirror a link or knot with pd_code."}

pd_code_mirror-0.1.0/PKG-INFO

@@ -1,42 +0,0 @@
-Metadata-Version: 2.4
-Name: pd-code-mirror
-Version: 0.1.0
-Summary: # pd_code_mirror
-License: MIT
-License-File: LICENSE
-Author: mirror a link or knot with pd_code.
-Requires-Python: >=3.10
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: pd-code-sanity (>=0.1.0)
-Description-Content-Type: text/markdown
-
-# pd-code-mirror
-
-Construct the mirror of a PD code.
-
-## Installation
-
-```bash
-pip install pd-code-mirror
-```
-
-## Quick start
-
-`from pd_code_mirror import mirror_pd_code`.
-
-PD codes are lists of four-entry crossings. Each arc label must occur exactly twice. Functions validate their inputs and do not mutate caller-owned PD-code lists unless explicitly documented.
-
-## Development
-
-Use Python 3.10 or newer for Python packages. Build distributions with `poetry build`. Run the package's tests or examples before publishing. C++ projects require a modern standards-compliant compiler.
-
-## License
-
-MIT. See `LICENSE`.
-

pd_code_mirror-0.1.0/README.md

@@ -1,23 +0,0 @@
-# pd-code-mirror
-
-Construct the mirror of a PD code.
-
-## Installation
-
-```bash
-pip install pd-code-mirror
-```
-
-## Quick start
-
-`from pd_code_mirror import mirror_pd_code`.
-
-PD codes are lists of four-entry crossings. Each arc label must occur exactly twice. Functions validate their inputs and do not mutate caller-owned PD-code lists unless explicitly documented.
-
-## Development
-
-Use Python 3.10 or newer for Python packages. Build distributions with `poetry build`. Run the package's tests or examples before publishing. C++ projects require a modern standards-compliant compiler.
-
-## License
-
-MIT. See `LICENSE`.