omoika 2.1.0__tar.gz

omoika-2.1.0/LICENSE

@@ -0,0 +1,9 @@
+
+
+Copyright 2023 jerlendds
+
+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.

omoika-2.1.0/PKG-INFO

@@ -0,0 +1,255 @@
+Metadata-Version: 2.4
+Name: omoika
+Version: 2.1.0
+Summary: The Omoika plugins framework for graph-based information analysis and offline local-first investigative workflows.
+Keywords: osint,open source intelligence,transform-pipeline,intelligence,plugins,graph,crawl,crawling,web,scraping,security,reconnaissance,enrichment,entity,analysis,investigation,threat,attribution,cti,threat-hunting,recon,attack-surface,entity-resolution,knowledge-graph,plugin-framework,extensible,python-plugins,investigative-journalism,research-tools,digital-investigations,provenance,compliance,local-first,offline,browser-automation,maltego
+Author-email: jerlendds <jerlendds@omoika.space>
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Classifier: Framework :: AsyncIO
+Classifier: Environment :: Console
+Classifier: Natural Language :: English
+Classifier: Topic :: Software Development
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Security
+Classifier: Topic :: System :: Archiving
+Classifier: Topic :: System :: Networking :: Monitoring
+Classifier: Topic :: Utilities
+License-File: LICENSE
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: packaging>=21.0
+Requires-Dist: httpx[http2]>=0.28.1
+Requires-Dist: beautifulsoup4>=4.14.3
+Requires-Dist: rich>=14.2.0
+Requires-Dist: dulwich>=1.1.0
+Requires-Dist: selenium>=4.39.0 ; extra == "all"
+Requires-Dist: playwright>=1.57.0 ; extra == "all"
+Requires-Dist: pytest>=9.0.2 ; extra == "dev"
+Requires-Dist: pytest-asyncio>=1.3.0 ; extra == "dev"
+Requires-Dist: ruff>=0.14.11 ; extra == "dev"
+Requires-Dist: mypy>=1.19.0 ; extra == "dev"
+Requires-Dist: black>=25.12.0 ; extra == "dev"
+Requires-Dist: pytest-cov>=7.0.0 ; extra == "dev"
+Project-URL: Changelog, https://github.com/omoika/plugins/releases
+Project-URL: Documentation, https://docs.omoika.space/
+Project-URL: Homepage, https://omoika.space
+Project-URL: Repository, https://github.com/omoika/omoika
+Project-URL: Source, https://github.com/omoika/plugins
+Project-URL: Tracker, https://github.com/omoika/omoika/issues
+Provides-Extra: all
+Provides-Extra: dev
+
+## Introducing Omoika: Reloaded
+
+<p>
+  <a href="https://github.com/omoika/omoika">
+    <img src="./watermark.svg" height="130px" alt="Logo">
+  </a>
+
+> _I have no data yet. It is a capital mistake to theorize before one has data. Insensibly
+> one begins to twist facts to suit theories, instead of theories to suit facts._
+
+---
+
+# The Omoika Plugins Framework
+
+[![PyPI version](https://badge.fury.io/py/omoika.svg)](https://pypi.org/project/omoika/)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+The plugin framework for [Omoika](https://github.com/omoika/omoika), a graph-based OSINT platform for recon, OSINT investigations, link analysis, and more. Offline. Local-first workflows. No cloud dependency.
+
+## Overview
+
+Omoika's plugin system enables you to define **entities** (_nodes in the graph_) and **transforms** (_operations that create new entities from existing ones_). The framework provides:
+
+- **Entity definitions** with rich metadata, icons, colors, and form elements
+- **Transform decorators** with dependency management and version targeting
+- **Result types** for subgraphs, custom edges, and file attachments
+- **Field types** for semantic type-based transform matching
+- **Settings framework** for persistent configuration
+- **CLI tools** for development and integration
+
+## Installation
+
+```bash
+pip install omoika[all]
+```
+
+For development:
+
+```bash
+git clone https://github.com/omoika/plugins.git
+cd plugins/
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+### Define an Entity
+
+```python
+from omoika import Plugin
+from omoika.elements import TextInput, CopyText
+from omoika.types import FieldType
+
+class EmailEntity(Plugin):
+    version = "1.0.0"
+    label = "Email"
+    icon = "mail"
+    color = "#3B82F6"
+    category = "Identity"
+
+    elements = [
+        TextInput(label="Email", icon="mail", field_type=FieldType.EMAIL),
+        CopyText(label="Domain"),
+    ]
+```
+
+### Create a Transform
+
+```python
+from omoika import transform, Entity, Edge
+
+@transform(
+    target="email@>=1.0.0",
+    label="Extract Domain",
+    icon="world",
+)
+async def extract_domain(entity):
+    email = entity.email
+    domain = email.split("@")[1] if "@" in email else None
+
+    if domain:
+        return Entity(
+            data=DomainEntity.blueprint(domain=domain),
+            edge=Edge(label="has domain"),
+        )
+```
+
+### Run a Transform
+
+```bash
+ob run -T '{"label": "email", "version": "1.0.0", "transform": "extract_domain", "data": {"email": "user@example.com"}}'
+```
+
+## Documentation
+
+| Guide                                      | Description                                         |
+| ------------------------------------------ | --------------------------------------------------- |
+| [Getting Started](docs/getting-started.md) | Installation, project setup, and first plugin       |
+| [Plugins & Entities](docs/plugins.md)      | Defining entities with the Plugin class             |
+| [Transforms](docs/transforms.md)           | Creating transforms with the `@transform` decorator |
+| [Elements](docs/elements.md)               | Input and display elements for entity forms         |
+| [Field Types](docs/types.md)               | Semantic types for fields and type-based matching   |
+| [Settings](docs/settings.md)               | Transform configuration and persistence             |
+| [CLI Reference](docs/cli.md)               | Command-line interface documentation                |
+| [API Reference](docs/api-reference.md)     | Complete API documentation                          |
+
+## Key Concepts
+
+### Plugins & Entities
+
+Every node type in the graph is defined as a `Plugin` subclass. Plugins are automatically registered when defined:
+
+```python
+class IPAddress(Plugin):
+    version = "1.0.0"
+    label = "IP Address"
+    elements = [TextInput(label="IP", field_type=FieldType.IP_ADDRESS)]
+```
+
+### Transforms
+
+Transforms operate on entities to produce new entities. They target specific entity versions:
+
+```python
+@transform(target="ip_address@>=1.0.0", label="GeoIP Lookup", deps=["geoip2"])
+async def geoip_lookup(entity):
+    # Transform logic
+    return Entity(data=Location.blueprint(city="..."))
+```
+
+### Result Types
+
+Transforms return `Entity`, `Edge`, `File`, or `Subgraph` objects:
+
+```python
+return Entity(
+    data=TargetEntity.blueprint(field="value"),
+    edge=Edge(label="discovered", color="#22C55E"),
+    files=[File(path="/tmp/report.pdf")],
+)
+```
+
+## Project Structure
+
+For plugin development and registry submissions, organize your code as:
+
+```
+my-plugins-repo/
+├── entities/
+│   ├── email.py
+│   ├── domain.py
+│   └── ip_address.py
+└── transforms/
+    ├── email_transforms.py
+    ├── domain_transforms.py
+    ├── network_traceroute_transform.py
+    └── network_transforms.py
+```
+
+Load plugins via:
+
+```python
+from omoika import load_plugins_fs
+load_plugins_fs("/path/to/my-plugins", "my_plugins")
+```
+
+## CLI Commands
+
+```bash
+# List entities and transforms
+ob ls entities
+ob ls transforms -L email
+
+# Run a transform
+ob transform '{"label": "email", "version": "1.0.0", "transform": "to_domain", "data": {...}}'
+
+# Get entity blueprints
+ob blueprints -L email
+
+# Initialize a new plugins project
+ob init
+
+# Sync manifest and README metadata after repo changes
+ob sync
+
+# Compile JSON entity to Python
+ob compile entity.json -O entity.py
+```
+
+## Requirements
+
+- Python 3.13+
+
+## License
+
+MIT License, see [LICENSE](LICENSE) for details.
+
+## Links
+
+<!-- - [Documentation](https://docs.omoika.space/) -->
+
+- [Omoika Application](https://github.com/omoika/omoika)
+- [Issue Tracker](https://github.com/omoika/omoika/issues)
+

omoika-2.1.0/README.md

@@ -0,0 +1,204 @@
+## Introducing Omoika: Reloaded
+
+<p>
+  <a href="https://github.com/omoika/omoika">
+    <img src="./watermark.svg" height="130px" alt="Logo">
+  </a>
+
+> _I have no data yet. It is a capital mistake to theorize before one has data. Insensibly
+> one begins to twist facts to suit theories, instead of theories to suit facts._
+
+---
+
+# The Omoika Plugins Framework
+
+[![PyPI version](https://badge.fury.io/py/omoika.svg)](https://pypi.org/project/omoika/)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+The plugin framework for [Omoika](https://github.com/omoika/omoika), a graph-based OSINT platform for recon, OSINT investigations, link analysis, and more. Offline. Local-first workflows. No cloud dependency.
+
+## Overview
+
+Omoika's plugin system enables you to define **entities** (_nodes in the graph_) and **transforms** (_operations that create new entities from existing ones_). The framework provides:
+
+- **Entity definitions** with rich metadata, icons, colors, and form elements
+- **Transform decorators** with dependency management and version targeting
+- **Result types** for subgraphs, custom edges, and file attachments
+- **Field types** for semantic type-based transform matching
+- **Settings framework** for persistent configuration
+- **CLI tools** for development and integration
+
+## Installation
+
+```bash
+pip install omoika[all]
+```
+
+For development:
+
+```bash
+git clone https://github.com/omoika/plugins.git
+cd plugins/
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+### Define an Entity
+
+```python
+from omoika import Plugin
+from omoika.elements import TextInput, CopyText
+from omoika.types import FieldType
+
+class EmailEntity(Plugin):
+    version = "1.0.0"
+    label = "Email"
+    icon = "mail"
+    color = "#3B82F6"
+    category = "Identity"
+
+    elements = [
+        TextInput(label="Email", icon="mail", field_type=FieldType.EMAIL),
+        CopyText(label="Domain"),
+    ]
+```
+
+### Create a Transform
+
+```python
+from omoika import transform, Entity, Edge
+
+@transform(
+    target="email@>=1.0.0",
+    label="Extract Domain",
+    icon="world",
+)
+async def extract_domain(entity):
+    email = entity.email
+    domain = email.split("@")[1] if "@" in email else None
+
+    if domain:
+        return Entity(
+            data=DomainEntity.blueprint(domain=domain),
+            edge=Edge(label="has domain"),
+        )
+```
+
+### Run a Transform
+
+```bash
+ob run -T '{"label": "email", "version": "1.0.0", "transform": "extract_domain", "data": {"email": "user@example.com"}}'
+```
+
+## Documentation
+
+| Guide                                      | Description                                         |
+| ------------------------------------------ | --------------------------------------------------- |
+| [Getting Started](docs/getting-started.md) | Installation, project setup, and first plugin       |
+| [Plugins & Entities](docs/plugins.md)      | Defining entities with the Plugin class             |
+| [Transforms](docs/transforms.md)           | Creating transforms with the `@transform` decorator |
+| [Elements](docs/elements.md)               | Input and display elements for entity forms         |
+| [Field Types](docs/types.md)               | Semantic types for fields and type-based matching   |
+| [Settings](docs/settings.md)               | Transform configuration and persistence             |
+| [CLI Reference](docs/cli.md)               | Command-line interface documentation                |
+| [API Reference](docs/api-reference.md)     | Complete API documentation                          |
+
+## Key Concepts
+
+### Plugins & Entities
+
+Every node type in the graph is defined as a `Plugin` subclass. Plugins are automatically registered when defined:
+
+```python
+class IPAddress(Plugin):
+    version = "1.0.0"
+    label = "IP Address"
+    elements = [TextInput(label="IP", field_type=FieldType.IP_ADDRESS)]
+```
+
+### Transforms
+
+Transforms operate on entities to produce new entities. They target specific entity versions:
+
+```python
+@transform(target="ip_address@>=1.0.0", label="GeoIP Lookup", deps=["geoip2"])
+async def geoip_lookup(entity):
+    # Transform logic
+    return Entity(data=Location.blueprint(city="..."))
+```
+
+### Result Types
+
+Transforms return `Entity`, `Edge`, `File`, or `Subgraph` objects:
+
+```python
+return Entity(
+    data=TargetEntity.blueprint(field="value"),
+    edge=Edge(label="discovered", color="#22C55E"),
+    files=[File(path="/tmp/report.pdf")],
+)
+```
+
+## Project Structure
+
+For plugin development and registry submissions, organize your code as:
+
+```
+my-plugins-repo/
+├── entities/
+│   ├── email.py
+│   ├── domain.py
+│   └── ip_address.py
+└── transforms/
+    ├── email_transforms.py
+    ├── domain_transforms.py
+    ├── network_traceroute_transform.py
+    └── network_transforms.py
+```
+
+Load plugins via:
+
+```python
+from omoika import load_plugins_fs
+load_plugins_fs("/path/to/my-plugins", "my_plugins")
+```
+
+## CLI Commands
+
+```bash
+# List entities and transforms
+ob ls entities
+ob ls transforms -L email
+
+# Run a transform
+ob transform '{"label": "email", "version": "1.0.0", "transform": "to_domain", "data": {...}}'
+
+# Get entity blueprints
+ob blueprints -L email
+
+# Initialize a new plugins project
+ob init
+
+# Sync manifest and README metadata after repo changes
+ob sync
+
+# Compile JSON entity to Python
+ob compile entity.json -O entity.py
+```
+
+## Requirements
+
+- Python 3.13+
+
+## License
+
+MIT License, see [LICENSE](LICENSE) for details.
+
+## Links
+
+<!-- - [Documentation](https://docs.omoika.space/) -->
+
+- [Omoika Application](https://github.com/omoika/omoika)
+- [Issue Tracker](https://github.com/omoika/omoika/issues)

omoika-2.1.0/pyproject.toml

@@ -0,0 +1,160 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "omoika"
+authors = [
+    {name = "jerlendds", email = "jerlendds@omoika.space"},
+]
+description = "The Omoika plugins framework for graph-based information analysis and offline local-first investigative workflows."
+readme = "README.md"
+license = {text = "MIT"}
+classifiers = [
+    "Framework :: AsyncIO",
+    "Environment :: Console",
+    "Natural Language :: English",
+    "Topic :: Software Development",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Scientific/Engineering :: Information Analysis", 
+    "Topic :: Security",
+    "Topic :: System :: Archiving", 
+    "Topic :: System :: Networking :: Monitoring", 
+    "Topic :: Utilities"
+]
+keywords = ["osint", "open source intelligence", "transform-pipeline", "intelligence", "plugins", "graph", "crawl", "crawling", "web", "scraping", "security", "reconnaissance","enrichment", "entity", "analysis", "investigation", "threat", "attribution", "cti", "threat-hunting", "recon", "attack-surface", "entity-resolution", "knowledge-graph", "plugin-framework", "extensible", "python-plugins", "investigative-journalism", "research-tools", "digital-investigations",  "provenance", "compliance", "local-first", "offline", "browser-automation", "maltego"]
+requires-python = ">=3.13"
+dynamic = ["version"]
+
+dependencies = [
+    "pydantic>=2.12.5",
+    "packaging>=21.0",
+    "httpx[http2]>=0.28.1",
+    "beautifulsoup4>=4.14.3",
+    "rich>=14.2.0",
+    "dulwich>=1.1.0",
+]
+
+[project.optional-dependencies]
+ # Development dependencies
+dev = [
+    "pytest>=9.0.2",
+    "pytest-asyncio>=1.3.0",
+    "ruff>=0.14.11",
+    "mypy>=1.19.0",
+    "black>=25.12.0",
+    "pytest-cov>=7.0.0",
+]
+#  Browser automation, used by some default Omoika plugins
+all = [
+    "selenium>=4.39.0",
+    "playwright>=1.57.0",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+    "pytest-asyncio>=1.3.0",
+    "ruff>=0.14.11",
+    "mypy>=1.19.0",
+    "black>=25.12.0",
+    "pytest-cov>=7.0.0",
+    "selenium>=4.39.0",
+    "playwright>=1.57.0",
+    "pydantic>=2.12.5",
+    "packaging>=21.0",
+    "httpx[http2]>=0.28.1",
+    "beautifulsoup4>=4.14.3",
+    "rich>=14.2.0",
+    "dulwich>=1.1.0",
+    "pyinstaller>=6.19.0",
+]
+
+[project.urls]
+Homepage = "https://omoika.space"
+Documentation = "https://docs.omoika.space/"
+Repository = "https://github.com/omoika/omoika"
+Source = "https://github.com/omoika/plugins"
+Tracker = "https://github.com/omoika/omoika/issues"
+Changelog = "https://github.com/omoika/plugins/releases"
+
+[project.scripts]
+ob = "omoika.ob:main"
+
+[tool.flit.module]
+name = "omoika"
+
+[tool.ruff]
+line-length = 120
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "C4"]
+ignore = ["E501", "B008"]
+
+[tool.mypy]
+python_version = "3.13"
+warn_return_any = true
+warn_unused_ignores = true
+disallow_untyped_defs = false
+check_untyped_defs = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+addopts = "-v"
+pythonpath = ["src"]
+markers = [
+    "integration: marks as integration test",
+    "slow: marks tests as slow",
+    "unit: fast offline tests",
+]
+
+[tool.black]
+line-length = 120
+target-version = ['py311', 'py312']
+
+[tool.coverage.run]
+branch = true
+source = ["src/omoika"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+]
+
+[tool.bandit]
+exclude_dirs = ["build", "dist", "tests", "scripts"]
+number = 4
+recursive = true
+targets = "src"
+
+[tool.pyright]
+include = ["src"]
+exclude = [
+    "**/node_modules",
+    "**/__pycache__",
+]
+pythonVersion = "3.13"
+pythonPlatform = "Linux"
+typeCheckingMode = "basic"
+reportMissingImports = true
+reportMissingTypeStubs = false
+
+[tool.hatch.build.targets.sdist.force-include]
+"bin/ob.py" = "omoika/ob.py"
+
+[tool.hatch.build.targets.wheel.force-include]
+"bin/ob.py" = "omoika/ob.py"
+