hinge 0.1.0__tar.gz → 0.1.2__tar.gz

{hinge-0.1.0 → hinge-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: hinge
-Version: 0.1.0
+Version: 0.1.2
 Summary: Heterogeneous Information Network tool for GitHub research datasets
 Project-URL: Homepage, https://github.com/marcotonnarelli/hinge
 Project-URL: Repository, https://github.com/marcotonnarelli/hinge
@@ -42,6 +42,20 @@ Requires-Dist: fastapi>=0.111; extra == 'web'
 Requires-Dist: uvicorn>=0.30; extra == 'web'
 Description-Content-Type: text/markdown
 
+<p align="center">
+  <img src="https://raw.githubusercontent.com/marcotonnarelli/hinge/main/docs/assets/logo.svg" alt="HINGE logo" width="200">
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/hinge/"><img alt="PyPI" src="https://img.shields.io/pypi/v/hinge"></a>
+  <a href="https://pypi.org/project/hinge/"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/hinge"></a>
+  <a href="https://github.com/marcotonnarelli/hinge/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/hinge"></a>
+  <a href="https://github.com/astral-sh/ruff"><img alt="Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"></a>
+  <a href="https://github.com/astral-sh/uv"><img alt="uv" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json"></a>
+  <a href="https://mypy-lang.org/"><img alt="mypy" src="https://img.shields.io/badge/types-mypy-blue"></a>
+  <img alt="MSR 2027" src="https://img.shields.io/badge/MSR-2027-blueviolet">
+</p>
+
 # HINGE — Heterogeneous Information Network for Generalized Extraction 
 
 `hinge` ingests GitHub activity datasets (JSONL today; CSV/Parquet planned), persists
@@ -49,7 +63,25 @@ them as a typed multi-relational graph in DuckDB, and exposes **projections**
 dbt SQL models that derive task-specific sub-graphs and export them to formats
 consumed by Gephi, NetworkX, igraph, etc.
 
-This is a research artefact accompanying an ICSME 2026 Tools and Data Showcase submission.
+This is a research artefact accompanying an MSR 2027 Data and Tool Showcase Track submission.
+
+## Installation
+
+`hinge` is available on PyPI:
+
+```bash
+pip install hinge
+```
+
+This installs the `hinge` CLI and exposes the package as a Python library:
+
+```python
+import hinge
+
+hinge.ingest(...)
+hinge.project(...)
+hinge.export(...)
+```
 
 ---
 
@@ -159,7 +191,7 @@ emits no edges will therefore produce no nodes either. The workaround is to use
 visible to the exporter, carry metadata in `properties`, and can be filtered out
 in downstream tools with `G.remove_edges_from(nx.selfloop_edges(G))`.
 
-See [dev_interaction.sql](hinge/dbt/models/networks/dev_interaction.sql)
+See [dev_interaction.sql](https://github.com/marcotonnarelli/hinge/blob/main/hinge/dbt/models/networks/dev_interaction.sql)
 for a full working example with a documented input/output contract.
 
 ### Step 2 — Create the spec module
@@ -229,7 +261,14 @@ The SQL file is temporarily added to the built-in dbt project, so it can use
 `hinge/dbt/macros/`. It must still emit the standard `network_edges` schema.
 Use `--name valid_model_name` if the filename is not a valid dbt identifier.
 
-See [docs/custom-projections.md](docs/custom-projections.md).
+See [custom-projections.md](https://github.com/marcotonnarelli/hinge/blob/main/docs/custom-projections.md).
+
+### Third-party plugins
+
+Readers, exporters, projection specs, stores, and projection engines can be
+shipped as separate PyPI packages — `hinge` discovers them through standard
+Python entry-points, with no plugin API to learn beyond the kernel protocols.
+See [plugins.md](https://github.com/marcotonnarelli/hinge/blob/main/docs/plugins.md) for the contract and a worked example.
 
 ---
 

{hinge-0.1.0 → hinge-0.1.2}/README.md

@@ -1,3 +1,17 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/marcotonnarelli/hinge/main/docs/assets/logo.svg" alt="HINGE logo" width="200">
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/hinge/"><img alt="PyPI" src="https://img.shields.io/pypi/v/hinge"></a>
+  <a href="https://pypi.org/project/hinge/"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/hinge"></a>
+  <a href="https://github.com/marcotonnarelli/hinge/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/hinge"></a>
+  <a href="https://github.com/astral-sh/ruff"><img alt="Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"></a>
+  <a href="https://github.com/astral-sh/uv"><img alt="uv" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json"></a>
+  <a href="https://mypy-lang.org/"><img alt="mypy" src="https://img.shields.io/badge/types-mypy-blue"></a>
+  <img alt="MSR 2027" src="https://img.shields.io/badge/MSR-2027-blueviolet">
+</p>
+
 # HINGE — Heterogeneous Information Network for Generalized Extraction 
 
 `hinge` ingests GitHub activity datasets (JSONL today; CSV/Parquet planned), persists
@@ -5,7 +19,25 @@ them as a typed multi-relational graph in DuckDB, and exposes **projections**
 dbt SQL models that derive task-specific sub-graphs and export them to formats
 consumed by Gephi, NetworkX, igraph, etc.
 
-This is a research artefact accompanying an ICSME 2026 Tools and Data Showcase submission.
+This is a research artefact accompanying an MSR 2027 Data and Tool Showcase Track submission.
+
+## Installation
+
+`hinge` is available on PyPI:
+
+```bash
+pip install hinge
+```
+
+This installs the `hinge` CLI and exposes the package as a Python library:
+
+```python
+import hinge
+
+hinge.ingest(...)
+hinge.project(...)
+hinge.export(...)
+```
 
 ---
 
@@ -115,7 +147,7 @@ emits no edges will therefore produce no nodes either. The workaround is to use
 visible to the exporter, carry metadata in `properties`, and can be filtered out
 in downstream tools with `G.remove_edges_from(nx.selfloop_edges(G))`.
 
-See [dev_interaction.sql](hinge/dbt/models/networks/dev_interaction.sql)
+See [dev_interaction.sql](https://github.com/marcotonnarelli/hinge/blob/main/hinge/dbt/models/networks/dev_interaction.sql)
 for a full working example with a documented input/output contract.
 
 ### Step 2 — Create the spec module
@@ -185,7 +217,14 @@ The SQL file is temporarily added to the built-in dbt project, so it can use
 `hinge/dbt/macros/`. It must still emit the standard `network_edges` schema.
 Use `--name valid_model_name` if the filename is not a valid dbt identifier.
 
-See [docs/custom-projections.md](docs/custom-projections.md).
+See [custom-projections.md](https://github.com/marcotonnarelli/hinge/blob/main/docs/custom-projections.md).
+
+### Third-party plugins
+
+Readers, exporters, projection specs, stores, and projection engines can be
+shipped as separate PyPI packages — `hinge` discovers them through standard
+Python entry-points, with no plugin API to learn beyond the kernel protocols.
+See [plugins.md](https://github.com/marcotonnarelli/hinge/blob/main/docs/plugins.md) for the contract and a worked example.
 
 ---
 

{hinge-0.1.0 → hinge-0.1.2}/docs/README.md

@@ -6,6 +6,7 @@ Current maintained docs:
 |---|---|
 | [architecture.md](architecture.md) | Microkernel + pipeline architecture, dependency rules, and extension points. |
 | [custom-projections.md](custom-projections.md) | How to write and run local dbt SQL projections. |
+| [plugins.md](plugins.md) | How to publish a third-party plugin (reader, exporter, projection spec, store). |
 | [architecture.drawio](architecture.drawio) | Current architecture diagram source. |
 
 Historical design sketches, backup diagrams, and executable prototype notebook files were removed from `docs/` to keep the public documentation focused on the current `hinge` tool. They remain recoverable from git history.

{hinge-0.1.0 → hinge-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hinge"
-version = "0.1.0"
+version = "0.1.2"
 description = "Heterogeneous Information Network tool for GitHub research datasets"
 readme = "README.md"
 requires-python = ">=3.12"