Metadata-Version: 2.4
Name: heimdallgov
Version: 0.1.1
Summary: Heimdall Federal Intelligence Platform — command-line client
Project-URL: Homepage, https://heimdallgov.com
Project-URL: Documentation, https://heimdallgov.com/docs
Project-URL: Issues, https://heimdallgov.com/support
Author-email: Ben Huddle <bnhuddle@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Heimdall Analytics Corporation
        
        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.
License-File: LICENSE
Keywords: cli,compliance,fac,federal,gao,government,heimdall,oig,oversight
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 :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Office/Business
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27.0
Requires-Dist: platformdirs>=4.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: typer>=0.12.0
Provides-Extra: dev
Requires-Dist: build>=1.2.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: twine>=5.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# heimdallgov

**Heimdall** is a federal oversight data platform, delivered through a CLI and
an MCP server. This package (`heimdallgov` on PyPI, installs the `heimdall`
command) is the CLI client — it talks to the Heimdall API
(`https://api.heimdallgov.com`) to search oversight findings, look up
contractor profiles, and pull compliance intel.

## Install

```bash
pip install heimdallgov
```

Requires Python 3.10 or newer.

## Authenticate

Get an API key by signing up at <https://heimdallgov.com>. Then either export
it as an environment variable:

```bash
export HEIMDALL_API_KEY=hml_sk_...
```

…or save it with the CLI (stored at your user-config dir, e.g.
`~/.config/heimdall/config` on Linux, `%APPDATA%\heimdall\config` on Windows):

```bash
heimdall auth login hml_sk_...
heimdall auth whoami
```

## Example commands

### Search oversight findings

```bash
heimdall findings search cybersecurity --limit 10
```

Returns recent GAO / Inspector General / FAC findings that mention the keyword,
with agency, severity, source, and report number.

### Look up a contractor

```bash
# Search contractors_master by name
heimdall risk search "Booz Allen"

# Fetch a full profile by UEI
heimdall risk ABCDEF123456
```

### Compliance profile

```bash
# Full compliance overview for a UEI
heimdall compliance profile ABCDEF123456

# Federal Audit Clearinghouse timeline
heimdall compliance fac ABCDEF123456 --limit 20

# Program / CFDA exposure
heimdall compliance programs ABCDEF123456

# Latest federal grant opportunities
heimdall compliance opportunities --limit 50
```

### Check subscription / usage

```bash
heimdall auth whoami           # tier, status
```

## Output formats

Every command renders a rich terminal table by default. Pipe through `jq` or
use the `--format json` flag on most commands to get machine-readable output.

## Environment variables

| Variable           | Purpose                                            | Default                        |
| ------------------ | -------------------------------------------------- | ------------------------------ |
| `HEIMDALL_API_KEY` | Bearer token used for every request                | (none — required)              |
| `HEIMDALL_API_URL` | Override the API base (mostly for local dev / QA)  | `https://api.heimdallgov.com`  |

## Full docs

<https://heimdallgov.com/docs>

## License

MIT. Copyright 2026 Heimdall Analytics Corporation.
