ontodag 0.1.0__tar.gz

ontodag-0.1.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: ontodag
+Version: 0.1.0
+Summary: Associative memory and categories based on a directed acyclic graph data structure
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: graphviz
+Requires-Dist: owlready2
+Requires-Dist: recordstore>=0.11
+Provides-Extra: web
+Requires-Dist: flask; extra == "web"
+Requires-Dist: dot2tex; extra == "web"
+Requires-Dist: Pillow; extra == "web"
+Provides-Extra: swarm
+Requires-Dist: requests; extra == "swarm"
+
+# OntoDAG
+
+Associative memory and categories based on a directed acyclic graph data structure
+
+## Documentation
+
+- **[User Guide](docs/USER_GUIDE.md)** — installation, tutorial, Python API,
+  command line, web app/REST, file formats, troubleshooting. Start here.
+- **[How It Works Inside](docs/HOW_IT_WORKS.md)** — the design in plain language
+  (canonical form, query planning, content-addressed persistence) and future plans.
+- `docs/SWARM_DESIGN.md`, `docs/SEMANTIC_CODES.md` — engineering design documents.
+
+See also **[ontodag-fs](https://github.com/petfold/ontodag-fs)**: any OntoDAG
+store can be browsed as a filesystem — paths are category queries, files are
+classified objects stored on Swarm, FUSE-mountable (`odag-fs`, which shares
+odag's store settings).
+
+## Specification
+
+A Directed Acyclic Graph (DAG) associative storage and category manager in Python. You can store items into a ontodag and recall items from it. To store or "put" an item into a ontodag, you give it a name and a set of other names of already existing items that are its supercategories. To recall or "get", you specify a set of item names to get all items that are subcategories of all these items.
+
+## Roadmap
+
+- [x] Implement the basic DAG data structure (put, remove)
+- [x] Simplify definitions not to include unnecessary links (e.g. bird under animal, animal is not needed)
+  - During put keep a dictionary of 'done' nodes of the inserted item and all its super categories
+  - Insert a link only to nodes which are not 'done'
+  - Increment counter only for items which are not 'done'
+- [x] Save/load data structure into/from file (try PKL)
+- [x] Load ontology from file (e.g. OWL)
+- [x] Visualize graph (with python library - Graphviz)
+- [x] More extensive test cases
+- [x] Select suitable ontology for importing (to serve as the basis of the DAG)
+- [x] Sub-class of OntoDAG with counters (for statistics)
+- [ ] Predicated (parametric) items. Dealing with items not stored in the graph (e.g. numbers, intervals, geo coordinates, areas; general, hierarchical types (types stored in the graph))
+- [ ] Implement space and time calculation for graph items (e.g. century, GPS bounding box)
+  - categories for item types, e.g. point in time, time interval, geo coordinates, geo area, url
+  - way to handle non-stored numerical types (time intervals, geo coordinates, areas, numbers, arbitrary types)
+  - way to store and retrieve ordered values (photo with exact time in response to "last week")
+  - ways to define (partial) ordering function
+  - file types (hierarchical, e.g. image, png)
+- [ ] Name usage across different instances of OntoDAG:
+  - namespaces
+  - avoiding confusing names (different language and usage, spelling)
+  - ability to merge DAGs with different name usage, using namespaces
+- [ ] Optimize retrieval and storage by choosing subsets of query items and finding existing nodes already stored in the DAG.
+- [ ] Add and remove intermediate nodes to optimize search in the graph
+- [ ] Port implementation to Golang
+- [ ] Implement a REST API for the Golang (or Rust) implementation
+- [ ] Interface with a graph database implementation.
+- [ ] Implement a web interface for the REST API & host it on a website with user profiles
+- [ ] Implement a limited functionality (DAG-only) graph database for Ethereum Swarm
+- [ ] Design a plugin for Ethereum Swarm to store the DAG in a decentralized way
+
+## Potential Applications
+* Using the ontology graph for content categorization instead of folders
+* Replace content tags with a more structured ontology
+* Access control (ACT) groups
+* Memberships in organizations and gate content based on membership
+* Communication channel groups defined by the ontology
+* Fostering deals within a universal marketplace for services and goods

ontodag-0.1.0/README.md

@@ -0,0 +1,61 @@
+# OntoDAG
+
+Associative memory and categories based on a directed acyclic graph data structure
+
+## Documentation
+
+- **[User Guide](docs/USER_GUIDE.md)** — installation, tutorial, Python API,
+  command line, web app/REST, file formats, troubleshooting. Start here.
+- **[How It Works Inside](docs/HOW_IT_WORKS.md)** — the design in plain language
+  (canonical form, query planning, content-addressed persistence) and future plans.
+- `docs/SWARM_DESIGN.md`, `docs/SEMANTIC_CODES.md` — engineering design documents.
+
+See also **[ontodag-fs](https://github.com/petfold/ontodag-fs)**: any OntoDAG
+store can be browsed as a filesystem — paths are category queries, files are
+classified objects stored on Swarm, FUSE-mountable (`odag-fs`, which shares
+odag's store settings).
+
+## Specification
+
+A Directed Acyclic Graph (DAG) associative storage and category manager in Python. You can store items into a ontodag and recall items from it. To store or "put" an item into a ontodag, you give it a name and a set of other names of already existing items that are its supercategories. To recall or "get", you specify a set of item names to get all items that are subcategories of all these items.
+
+## Roadmap
+
+- [x] Implement the basic DAG data structure (put, remove)
+- [x] Simplify definitions not to include unnecessary links (e.g. bird under animal, animal is not needed)
+  - During put keep a dictionary of 'done' nodes of the inserted item and all its super categories
+  - Insert a link only to nodes which are not 'done'
+  - Increment counter only for items which are not 'done'
+- [x] Save/load data structure into/from file (try PKL)
+- [x] Load ontology from file (e.g. OWL)
+- [x] Visualize graph (with python library - Graphviz)
+- [x] More extensive test cases
+- [x] Select suitable ontology for importing (to serve as the basis of the DAG)
+- [x] Sub-class of OntoDAG with counters (for statistics)
+- [ ] Predicated (parametric) items. Dealing with items not stored in the graph (e.g. numbers, intervals, geo coordinates, areas; general, hierarchical types (types stored in the graph))
+- [ ] Implement space and time calculation for graph items (e.g. century, GPS bounding box)
+  - categories for item types, e.g. point in time, time interval, geo coordinates, geo area, url
+  - way to handle non-stored numerical types (time intervals, geo coordinates, areas, numbers, arbitrary types)
+  - way to store and retrieve ordered values (photo with exact time in response to "last week")
+  - ways to define (partial) ordering function
+  - file types (hierarchical, e.g. image, png)
+- [ ] Name usage across different instances of OntoDAG:
+  - namespaces
+  - avoiding confusing names (different language and usage, spelling)
+  - ability to merge DAGs with different name usage, using namespaces
+- [ ] Optimize retrieval and storage by choosing subsets of query items and finding existing nodes already stored in the DAG.
+- [ ] Add and remove intermediate nodes to optimize search in the graph
+- [ ] Port implementation to Golang
+- [ ] Implement a REST API for the Golang (or Rust) implementation
+- [ ] Interface with a graph database implementation.
+- [ ] Implement a web interface for the REST API & host it on a website with user profiles
+- [ ] Implement a limited functionality (DAG-only) graph database for Ethereum Swarm
+- [ ] Design a plugin for Ethereum Swarm to store the DAG in a decentralized way
+
+## Potential Applications
+* Using the ontology graph for content categorization instead of folders
+* Replace content tags with a more structured ontology
+* Access control (ACT) groups
+* Memberships in organizations and gate content based on membership
+* Communication channel groups defined by the ontology
+* Fostering deals within a universal marketplace for services and goods

ontodag-0.1.0/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ontodag"
+version = "0.1.0"
+description = "Associative memory and categories based on a directed acyclic graph data structure"
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+    "graphviz",
+    "owlready2",
+    "recordstore>=0.11",
+]
+
+[project.optional-dependencies]
+web = ["flask", "dot2tex", "Pillow"]
+# The `swarm:NAME` CLI backend talks to a Bee node via recordstore's
+# BeeBytesStore, which needs `requests` (recordstore's own [bee] extra).
+swarm = ["requests"]
+
+[project.scripts]
+odag = "ontodag.__main__:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]

ontodag-0.1.0/setup.cfg

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

ontodag-0.1.0/src/ontodag/__init__.py

@@ -0,0 +1,17 @@
+from ontodag.dag import DAG, OntoDAG, Item, OntoDAGVisualizer
+
+
+def __getattr__(name):
+    # OWL support needs owlready2; import it only when actually used so the
+    # core data structure works without it.
+    if name == "OWLOntology":
+        from ontodag.owl import OWLOntology
+
+        return OWLOntology
+    # The Swarm adapter is optional persistence; keep plain `import ontodag`
+    # free of it (tests/test_boundaries.py, B1).
+    if name == "SwarmOntoDAG":
+        from ontodag.swarm_adapter import SwarmOntoDAG
+
+        return SwarmOntoDAG
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")