sharkit 0.1.0__tar.gz

sharkit-0.1.0/.gitignore

@@ -0,0 +1,28 @@
+.omo
+
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+
+.venv/
+venv/
+env/
+
+.vscode/
+.idea/
+*.swp
+*.swo
+
+.pytest_cache/
+.coverage
+htmlcov/
+
+.mypy_cache/
+.ruff_cache/
+
+*.pcap

sharkit-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sharkit Contributors
+
+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.

sharkit-0.1.0/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.5
+Name: sharkit
+Version: 0.1.0
+Summary: OSINT / HUMINT / GEOINT research framework
+Project-URL: Homepage, https://github.com/sshtmp/sharkit
+Project-URL: Repository, https://github.com/sshtmp/sharkit
+Project-URL: Issues, https://github.com/sshtmp/sharkit/issues
+Author: Sharkit Contributors
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,framework,geoint,humint,osint,research
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: httpx<1.0.0,>=0.27.0
+Requires-Dist: prompt-toolkit<4.0.0,>=3.0.0
+Description-Content-Type: text/markdown
+
+# Sharkit
+
+OSINT / HUMINT / GEOINT research framework
+
+## Installation
+
+```bash
+uv tool install sharkit
+```
+
+## Usage
+
+```bash
+sharkit
+```
+
+## Development
+
+```bash
+uv sync
+uv run sharkit
+```
+
+## Testing
+
+```bash
+uv run pytest
+```
+
+## Privacy
+
+Sharkit does not include telemetry, analytics, tracking, or background network requests. Network activity only happens as a result of explicit user action.
+
+## Disclaimer
+
+Sharkit is intended for lawful OSINT research, authorized security testing, education, and legitimate investigations. Users are responsible for complying with applicable laws, permissions, and terms of service. Sharkit does not guarantee anonymity.
+
+## License
+
+MIT

sharkit-0.1.0/README.md

@@ -0,0 +1,40 @@
+# Sharkit
+
+OSINT / HUMINT / GEOINT research framework
+
+## Installation
+
+```bash
+uv tool install sharkit
+```
+
+## Usage
+
+```bash
+sharkit
+```
+
+## Development
+
+```bash
+uv sync
+uv run sharkit
+```
+
+## Testing
+
+```bash
+uv run pytest
+```
+
+## Privacy
+
+Sharkit does not include telemetry, analytics, tracking, or background network requests. Network activity only happens as a result of explicit user action.
+
+## Disclaimer
+
+Sharkit is intended for lawful OSINT research, authorized security testing, education, and legitimate investigations. Users are responsible for complying with applicable laws, permissions, and terms of service. Sharkit does not guarantee anonymity.
+
+## License
+
+MIT

sharkit-0.1.0/pyproject.toml

@@ -0,0 +1,94 @@
+[project]
+name = "sharkit"
+version = "0.1.0"
+description = "OSINT / HUMINT / GEOINT research framework"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [
+    { name = "Sharkit Contributors" },
+]
+keywords = ["osint", "humint", "geoint", "research", "cli", "framework"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Security",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "prompt_toolkit>=3.0.0,<4.0.0",
+    "httpx>=0.27.0,<1.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/sshtmp/sharkit"
+Repository = "https://github.com/sshtmp/sharkit"
+Issues = "https://github.com/sshtmp/sharkit/issues"
+
+[project.scripts]
+sharkit = "sharkit.app:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/sharkit"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/sharkit",
+    "README.md",
+    "LICENSE",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0,<9.0.0",
+    "pytest-asyncio>=1.0.0,<2.0.0",
+    "ruff>=0.6.0,<1.0.0",
+    "mypy>=1.11.0,<2.0.0",
+]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 100
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "N",   # pep8-naming
+    "UP",  # pyupgrade
+    "B",   # flake8-bugbear
+    "SIM", # flake8-simplify
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["sharkit"]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

sharkit-0.1.0/src/sharkit/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "0.1.0"
+__app_name__ = "sharkit"

sharkit-0.1.0/src/sharkit/__main__.py

@@ -0,0 +1,5 @@
+import sys
+
+from sharkit.app import main
+
+sys.exit(main())

sharkit-0.1.0/src/sharkit/app.py

@@ -0,0 +1,80 @@
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+
+from sharkit.commands.builtins import BUILTIN_COMMANDS
+from sharkit.commands.registry import CommandRegistry
+from sharkit.config.manager import ConfigManager
+from sharkit.console.repl import Console
+from sharkit.exceptions import SharkitError
+from sharkit.history.manager import HistoryManager
+from sharkit.modules.loader import discover_modules
+from sharkit.modules.registry import ModuleRegistry
+from sharkit.network.client import HttpClient
+from sharkit.output.renderer import Renderer
+
+NON_LINUX_MESSAGE = (
+    "sharkit is a shark.\n"
+    "it was built for open water,\n"
+    "where it can actually swim.\n"
+    "\n"
+    "windows/mac is more of a glass aquarium.\n"
+    "tidy, bright, and a little too enclosed.\n"
+    "\n"
+    "the shark doesn't dislike the aquarium.\n"
+    "it just wasn't shaped for it,\n"
+    "and it shows.\n"
+    "\n"
+    "find us in linux.\n"
+    "mrrp :3"
+)
+
+
+def main() -> int:
+    sys.stdout.write("\033[2J\033[3J\033[H")
+    sys.stdout.flush()
+    renderer = Renderer()
+
+    if sys.platform != "linux":
+        renderer.banner(module_count=0, message=NON_LINUX_MESSAGE)
+        return 1
+
+    config_manager = ConfigManager()
+
+    history_manager = HistoryManager()
+
+    module_registry = ModuleRegistry()
+    modules_dir = Path(__file__).parent / "modules"
+    discovered = discover_modules(modules_dir)
+    for module_class, module_path in discovered:
+        module_registry.register_module(module_class, module_path)
+
+    command_registry = CommandRegistry()
+    for command_class in BUILTIN_COMMANDS:
+        command_registry.register_command(command_class)
+
+    http_client = HttpClient()
+
+    renderer.banner(module_count=len(discovered))
+    print()
+
+    console = Console(
+        command_registry=command_registry,
+        module_registry=module_registry,
+        config_manager=config_manager,
+        history_manager=history_manager,
+        renderer=renderer,
+    )
+
+    try:
+        console.run()
+    except KeyboardInterrupt:
+        print()
+    except SharkitError as exc:
+        renderer.error(str(exc))
+        return 1
+    finally:
+        http_client.close()
+
+    return 0

sharkit-0.1.0/src/sharkit/commands/__init__.py

@@ -0,0 +1,10 @@
+from sharkit.commands.base import Command, CommandContext
+from sharkit.commands.builtins import BUILTIN_COMMANDS
+from sharkit.commands.registry import CommandRegistry
+
+__all__ = [
+    "Command",
+    "CommandContext",
+    "CommandRegistry",
+    "BUILTIN_COMMANDS",
+]

sharkit-0.1.0/src/sharkit/commands/base.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from dataclasses import dataclass, field
+from typing import Any
+
+
+@dataclass
+class CommandContext:
+    session: dict[str, Any] = field(default_factory=dict)
+    modules: list[Any] = field(default_factory=list)
+    current_module: str | None = None
+    output: Any = None
+
+
+class Command(ABC):
+    name: str
+    aliases: list[str] = []
+    description: str = ""
+    usage: str = ""
+    options: list[tuple[str, str]] = []
+    notes: str = ""
+
+    @abstractmethod
+    def execute(self, context: CommandContext, args: list[str]) -> str | None: ...
+
+    def validate_args(self, args: list[str]) -> tuple[bool, str | None]:
+        return True, None
+
+    def format_help(self) -> str:
+        usage = self.usage or self.name
+        lines = [f"Usage: {usage}", "", self.description]
+        if self.notes:
+            lines.append("")
+            lines.append(self.notes)
+        if self.options:
+            lines.append("")
+            lines.append("OPTIONS:")
+            lines.append("")
+            max_flag = max((len(f) for f, _ in self.options), default=0)
+            for flag, desc in self.options:
+                lines.append(f"    {flag:<{max_flag}}  {desc}")
+        return "\n".join(lines)