openosint 1.0.0__tar.gz

openosint-1.0.0/.env.example

@@ -0,0 +1,28 @@
+# OpenOSINT Configuration
+# Copy this file to .env and fill in your API keys
+
+# ─── Required ────────────────────────────────────────────────
+# Primary AI provider (Anthropic)
+ANTHROPIC_API_KEY=sk-ant-...
+
+# ─── Optional — enhances investigation depth ─────────────────
+# OpenAI (alternative provider)
+OPENAI_API_KEY=sk-...
+
+# HaveIBeenPwned API key (paid, $3.50/month)
+# https://haveibeenpwned.com/API/Key
+HIBP_API_KEY=
+
+# AbuseIPDB API key (free tier available)
+# https://www.abuseipdb.com/api
+ABUSEIPDB_API_KEY=
+
+# ─── Provider selection ───────────────────────────────────────
+# Options: anthropic, openai, ollama (default: anthropic)
+OPENOSINT_PROVIDER=anthropic
+
+# Model override (defaults to claude-sonnet-4-20250514)
+OPENOSINT_MODEL=claude-sonnet-4-20250514
+
+# Ollama base URL (if using local models)
+OLLAMA_BASE_URL=http://localhost:11434

openosint-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint with ruff
+        run: ruff check openosint/ tests/
+
+      - name: Syntax check
+        run: |
+          find openosint tests -name "*.py" -exec python -m py_compile {} +
+
+      - name: Run tests
+        run: pytest -v tests/

openosint-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      - name: Lint
+        run: ruff check .
+      - name: Test
+        run: pytest tests/ -v
+
+  publish:
+    name: Publish to PyPI
+    needs: test
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/openosint
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Install build tools
+        run: pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+          body: |
+            ## Installation
+            ```bash
+            pip install openosint==${{ github.ref_name }}
+            ```
+            See [CHANGELOG.md](CHANGELOG.md) for full details.

openosint-1.0.0/.gitignore

@@ -0,0 +1,74 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*.manifest
+*.spec
+pip-log.txt
+pip-delete-this-directory.txt
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Virtual environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Environment files
+.env
+.env.local
+.env.*.local
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# OpenOSINT specific
+reports/
+*.osint
+*.report
+cache/
+.openosint_cache/
+
+# Distribution
+dist/
+build/
+*.egg-info/

openosint-1.0.0/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to OpenOSINT will be documented here.
+Format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [1.0.0] - 2026-05-08
+
+### Added
+- Initial release
+- Multi-provider support: Anthropic, OpenAI, Ollama
+- 9 OSINT tools: email, username, domain, breach, whois, ip, dorks, paste, phone
+- Native Anthropic tool use API (no hallucination)
+- Rich terminal UI with spinners, panels, tables
+- Auto-saved reports in Markdown, JSON, TXT
+- Interactive first-run config wizard
+- Legal disclaimer and ethical use policy
+- Documentation site

openosint-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing to OpenOSINT
+
+## Release Process
+
+Releases are automated via GitHub Actions.
+
+### First-time PyPI Setup (maintainer only)
+
+1. Go to https://pypi.org/manage/account/publishing/
+2. Add a new trusted publisher:
+   - PyPI project name: `openosint`
+   - Owner: your GitHub username
+   - Repository: `OpenOSINT`
+   - Workflow: `release.yml`
+   - Environment: `pypi`
+3. Go to GitHub repo → Settings → Environments → New environment → name it `pypi`
+
+### Cutting a Release
+
+```bash
+./scripts/release.sh 1.1.0
+```
+
+That's it. The workflow will:
+1. Run tests on Python 3.10, 3.11, 3.12
+2. Build the package
+3. Publish to PyPI
+4. Create a GitHub Release with auto-generated release notes

openosint-1.0.0/DISCLAIMER.md

@@ -0,0 +1,57 @@
+# Legal Disclaimer & Ethical Use Policy
+
+## Disclaimer
+
+OpenOSINT is an open source tool designed strictly for **legal, ethical, and authorized
+security research, OSINT investigations, and educational purposes**.
+
+The authors and contributors of OpenOSINT:
+
+- Take **no responsibility** for any misuse, damage, or illegal activity carried out
+  using this tool.
+- Do **not endorse** the use of this tool to violate any individual's privacy, to
+  harass, stalk, or harm any person, or to conduct unauthorized investigations.
+- Provide this software **"as is"**, without warranty of any kind, express or implied.
+
+## You Are Solely Responsible
+
+By using OpenOSINT, you agree that:
+
+1. You will only investigate targets for which you have **explicit authorization** or
+   a **legitimate legal basis** (e.g. your own accounts, authorized penetration testing,
+   law enforcement with proper warrant, or publicly available information research).
+2. You will comply with all applicable **local, national, and international laws**,
+   including but not limited to GDPR, CCPA, the Computer Fraud and Abuse Act (CFAA),
+   and equivalent legislation in your jurisdiction.
+3. You will **not use** this tool to collect, store, or process personal data without
+   appropriate legal basis.
+4. Any consequences resulting from the use of this tool are **your sole responsibility**.
+
+## Ethical Use
+
+OSINT is a legitimate discipline used by:
+- Security researchers and penetration testers
+- Journalists and investigative reporters
+- Law enforcement agencies (with proper authorization)
+- Individuals researching their own digital footprint
+
+It is **not** a tool for:
+- Stalking, harassment, or doxxing
+- Unauthorized surveillance
+- Identity theft or fraud
+- Any activity that violates another person's privacy or dignity
+
+## Third-Party Tools
+
+OpenOSINT wraps several third-party tools (holehe, sherlock, sublist3r, etc.).
+Each of these tools has its own license and terms of use. Users are responsible
+for complying with those terms independently.
+
+## No Warranty
+
+THIS 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 OF OR DEALINGS IN THE SOFTWARE.

openosint-1.0.0/LICENSE

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