gdeltforge 0.4.0__tar.gz

gdeltforge-0.4.0/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail
+address, posting via an official social media account, or acting as an
+appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+vinicius.teixeira.carvalho@usp.br.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited
+interaction with those enforcing the Code of Conduct, is allowed during this
+period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

gdeltforge-0.4.0/.github/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to GdeltForge
+
+Thanks for considering a contribution. This project is small and welcomes issues, bug fixes, documentation improvements, and new features alike.
+
+By participating, you're expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md). For security issues, see [SECURITY.md](SECURITY.md) instead of opening a public issue.
+
+## Getting set up
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management.
+
+```
+git clone https://github.com/Vinicius-Teixeirac/GdeltForge.git
+cd GdeltForge
+uv sync --group dev
+cp config/settings.example.yaml config/settings.yaml
+uv run pre-commit install
+```
+
+`pre-commit install` wires up git hooks (defined in `.pre-commit-config.yaml`) that run Ruff on every commit and Pyright + pytest on every push, so problems surface locally instead of in CI.
+
+Run the test suite (pure unit tests: no network, no browser, no real GDELT data required):
+
+```
+uv run pytest
+```
+
+To work on the documentation site:
+
+```
+uv sync --group docs
+uv run mkdocs serve
+```
+
+See the [full documentation](https://vinicius-teixeirac.github.io/GdeltForge/) for how the pipeline itself is organized and configured.
+
+## Making a change
+
+1. **Open an issue first for anything non-trivial** (new features, behavior changes, architectural changes) so we can agree on the approach before you put work into it. Small fixes and docs corrections can go straight to a PR.
+2. **Branch off `main`**: don't commit directly to it. Name the branch for what it does (`feat/...`, `fix/...`, `docs/...`).
+3. **Keep commits atomic and typed**: one logical change per commit, with a conventional-commits-style prefix describing its nature:
+   `feat`, `fix`, `perf`, `docs`, `chore`, `refactor`, `test`, or `ci`. Look at the existing git history for the style this repo follows.
+4. **Add or update tests** for any behavior change. `uv run pytest` should pass before you open a PR.
+5. **Update the docs** (`docs/`) if you're changing anything user-facing: a new CLI flag, a new config key, a changed default.
+6. **Open a pull request against `main`** using the PR template. CI (GitHub Actions) runs the test suite and a package build check on Python 3.10 and 3.12 automatically.
+
+## Code style
+
+This project uses [Ruff](https://docs.astral.sh/ruff/) for linting and [Pyright](https://microsoft.github.io/pyright/) for type checking; both run in CI and should pass before you open a PR:
+
+```
+uv sync --group lint
+uv run ruff check .
+uv run pyright
+```
+
+Beyond what the tools catch, prefer clarity and small, focused functions over cleverness. Comments should explain *why*, not *what*: the code should already say what it does.
+
+## Reporting bugs / requesting features
+
+Use the issue templates (Bug Report / Feature Request) when opening an issue on GitHub: they ask for the details that are usually needed to act on a report (GdeltForge version, Python version, config relevant to the issue, steps to reproduce).
+
+## License
+
+By contributing, you agree that your contributions will be licensed under this project's [Apache License 2.0](../LICENSE).

gdeltforge-0.4.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,77 @@
+name: Bug Report
+description: Something in GdeltForge isn't working as expected
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug. Please fill in as much of this as you can — it's the difference between a fix in a day and a fix in a month.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: What happened?
+      description: A clear description of the bug.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      description: The exact command(s) run, and any relevant config.
+      placeholder: |
+        1. `gdeltforge scrape --start-date 2020-01-01 --end-date 2020-01-31`
+        2. `gdeltforge convert`
+        3. ...
+      render: shell
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Output from `logs/pipeline.log` or the terminal. This will be rendered as a code block automatically.
+      render: shell
+
+  - type: input
+    id: version
+    attributes:
+      label: GdeltForge version
+      description: Output of `gdeltforge --version` if available, or the git commit/tag you're on.
+    validations:
+      required: true
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python version
+      description: Output of `python --version`
+    validations:
+      required: true
+
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      options:
+        - Windows
+        - macOS
+        - Linux
+        - Other
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Anything else relevant — relevant settings.yaml sections (redact anything sensitive), whether this happens consistently, etc.

gdeltforge-0.4.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Security vulnerability
+    url: https://github.com/Vinicius-Teixeirac/GdeltForge/security/advisories/new
+    about: Please report security vulnerabilities privately instead of opening a public issue.
+  - name: Documentation
+    url: https://vinicius-teixeirac.github.io/GdeltForge/
+    about: Check the docs site before filing — your question might already be answered there.

gdeltforge-0.4.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,36 @@
+name: Feature Request
+description: Suggest an idea or improvement for GdeltForge
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for the suggestion. For anything non-trivial, opening an issue first (rather than jumping straight to a PR) helps make sure we agree on the approach before work goes into it.
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: What problem does this solve?
+      description: What are you trying to do that GdeltForge doesn't support today?
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed solution
+      description: How would you like this to work? A CLI flag, a config option, a new pipeline stage, etc.
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+      description: Any workarounds you're currently using, or other approaches you considered.
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Anything else — links, examples from other tools, related issues.

gdeltforge-0.4.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+## Summary
+
+<!-- What does this change do, and why? Link any related issue. -->
+
+## Type of change
+
+- [ ] `feat`: new feature
+- [ ] `fix`: bug fix
+- [ ] `perf`: performance improvement
+- [ ] `docs`: documentation only
+- [ ] `refactor`: no behavior change
+- [ ] `test`: test-only change
+- [ ] `chore` / `ci`: tooling, dependencies, CI
+
+## Checklist
+
+- [ ] `uv run pytest` passes locally
+- [ ] `uv run ruff check .` and `uv run pyright` pass locally
+- [ ] Docs updated (`docs/`) if this changes user-facing behavior (CLI flags, config keys, defaults)
+- [ ] Commits are atomic and follow the type prefixes above
+- [ ] Branched from `main`, not committed directly to it
+
+## Test plan
+
+<!-- How did you verify this works? Commands run, output observed, edge cases checked. -->

gdeltforge-0.4.0/.github/SECURITY.md

@@ -0,0 +1,19 @@
+# Security Policy
+
+## Supported Versions
+
+GdeltForge is pre-1.0 and versioned from git tags (see [Releases](https://github.com/Vinicius-Teixeirac/GdeltForge/releases)). Only the latest released version is supported; please upgrade before reporting an issue if you're on an older one.
+
+## Reporting a Vulnerability
+
+Please **do not** open a public issue for security vulnerabilities.
+
+Instead, use GitHub's private vulnerability reporting:
+
+1. Go to the [Security tab](https://github.com/Vinicius-Teixeirac/GdeltForge/security) of this repository.
+2. Click **"Report a vulnerability"**.
+3. Describe the issue, including steps to reproduce and potential impact.
+
+This opens a private advisory visible only to the maintainer and you, and is the preferred way to report anything security-related.
+
+You should expect an initial response within a few days. If the report is confirmed, we'll work with you on a fix and a coordinated disclosure timeline before any public advisory is published.

gdeltforge-0.4.0/.github/workflows/ci.yml

@@ -0,0 +1,66 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # full history so hatch-vcs can see tags
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install dependencies
+        # setup-uv has no python-version input; uv manages/downloads the
+        # interpreter itself via --python (confirmed against its actual
+        # input schema, not assumed).
+        run: uv sync --group lint --python 3.12
+
+      - name: Ruff
+        run: uv run ruff check .
+
+      - name: Pyright
+        run: uv run pyright
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # full history so hatch-vcs can see tags
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install dependencies
+        # setup-uv has no python-version input; uv manages/downloads the
+        # interpreter itself via --python (confirmed against its actual
+        # input schema, not assumed).
+        run: uv sync --group dev --python ${{ matrix.python-version }}
+
+      - name: Run tests
+        run: uv run pytest -v
+
+      - name: Verify the package builds
+        run: uv build
+
+      - name: Check package metadata (twine)
+        run: uvx twine check dist/*
+
+      - name: Install built wheel and smoke-test the CLI
+        run: |
+          uv venv .smoke-venv
+          source .smoke-venv/bin/activate
+          uv pip install dist/*.whl
+          gdeltforge --help
+          gdeltforge codes ActionGeo_CountryCode

gdeltforge-0.4.0/.github/workflows/docs.yml

@@ -0,0 +1,52 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - docs/**
+      - mkdocs.yml
+      - .github/workflows/docs.yml
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install docs dependencies
+        # setup-uv has no python-version input; uv manages/downloads the
+        # interpreter itself via --python.
+        run: uv sync --group docs --python 3.12
+
+      - name: Build site
+        run: uv run mkdocs build --strict
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

gdeltforge-0.4.0/.github/workflows/publish.yml

@@ -0,0 +1,78 @@
+name: Publish
+
+on:
+  release:
+    types: [released]   # non-prerelease only — a GitHub prerelease won't touch real PyPI
+  workflow_dispatch: {}   # manual trigger, used only for the TestPyPI rehearsal
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # full history so hatch-vcs can see tags
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Check package metadata (twine)
+        run: uvx twine check dist/*
+
+      - name: Install built wheel and smoke-test the CLI
+        run: |
+          uv venv .smoke-venv
+          source .smoke-venv/bin/activate
+          uv pip install dist/*.whl
+          gdeltforge --help
+          gdeltforge codes ActionGeo_CountryCode
+
+      - name: Upload built distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-testpypi:
+    # Manual rehearsal only, re-runnable any time via Actions -> Publish -> Run workflow.
+    if: github.event_name == 'workflow_dispatch'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/gdeltforge/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    # The real thing — fires only when a non-prerelease GitHub Release is published.
+    if: github.event_name == 'release'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/gdeltforge/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

gdeltforge-0.4.0/.gitignore

@@ -0,0 +1,52 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+*.egg-info/
+*.egg
+dist/
+build/
+.eggs/
+
+# Generated at build time by hatch-vcs
+src/gdeltforge/_version.py
+
+# MkDocs build output
+site/
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# uv
+.python-version
+
+# Config (contains local paths — copy from settings.example.yaml)
+config/settings.yaml
+
+# Pipeline data directories
+*.zip
+*.csv
+*.parquet
+
+# Logs
+logs/
+
+# IDE
+.vscode/
+.idea/
+*.code-workspace
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Jupyter
+.ipynb_checkpoints/
+*.ipynb
+
+# Personal notes (not part of the public project)
+ROADMAP.md

gdeltforge-0.4.0/.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+default_install_hook_types: [pre-commit, pre-push]
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.0
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+        stages: [pre-commit]
+
+  - repo: local
+    hooks:
+      - id: pyright
+        name: pyright
+        entry: uv run pyright
+        language: system
+        pass_filenames: false
+        stages: [pre-push]
+
+      - id: pytest
+        name: pytest
+        entry: uv run pytest -q
+        language: system
+        pass_filenames: false
+        stages: [pre-push]