pydoge-api 0.1.2

PyDOGE API is an advanced, Python wrapper for interacting with the public-facing API of the Department of Government Efficiency (DOGE)

A Python library to interact with Department of Government Efficiency (DOGE) API.

🧾 Table of Contents

1. About The Project
2. Highlights
3. Getting Started
   • Installation
4. Usage
   • Synchronous Fetching
   • Asynchronous Pagination
5. Contributors
6. Acknowledgements

🐍 About The Project

PyDOGE API is an advanced, Python wrapper for interacting with the public-facing API of the Department of Government Efficiency (DOGE) — a federal initiative aimed at increasing transparency and fiscal accountability by sharing detailed datasets on:

• 💸 Cancelled grants
• 📑 Contract terminations
• 🏢 Lease reductions
• 🧾 Payment transactions

🚀 Features

• Auto-pagination (sync or async, fetch all pages if needed)
• .export() to CSV, Excel, or JSON with timestamped filenames
• .to_dataframe() for Pandas users
• .summary() with analytics (rows, nulls, dtypes, stats)
• summary(save_as="...") for file logging
• Returns Pydantic models & dict output
• Retry-safe client with 429 handling

This package enables data scientists and analysts to programmatically access and analyze the data with ease.

📌 Getting Started

Installation

Install:

pip install pydoge-api

Upgrade:

pip install --upgrade pydoge-api

Documentation

Full developer docs with API reference, usage, and model schema:

• 👉 Docs and Examples (PyDOGE)
• 👉 Official Swagger Page

📚 Usage

Synchronous Fetching

from pydoge_api import DogeAPI

api = DogeAPI(
    fetch_all=True,             # get all pages
    output_pydantic=False,      # dict output
    handle_response=True,       # parse response
    run_async=False             # ← synchronous mode
)

# Grants sorted by savings
grants = api.savings.get_grants(sort_by="savings")

# Filter payments by agency
payments = api.payments.get_payments(filter="agency", filter_value="NASA")

# Export to CSV
grants.export("grants_q1", format="csv")

# Show summary in terminal
grants.summary(verbose=True)

# Save the summary as markdown
grants.summary(save_as="logs/grants_summary.md")

Asynchronous Pagination

api = DogeAPI(
    fetch_all=True,
    output_pydantic=True,
    handle_response=True,
    run_async=True              # ← enable async parallel fetch
)

grants = api.savings.get_grants(sort_by="value")
print(grants.meta.total_results)

# Export to Excel
grants.export("grants_report", format="xlsx")

(back to top)

👪 Contributors

All contributions are welcome. If you have a suggestion that would make this better, please fork the repo and create a merge request. You can also simply open an issue with the label 'enhancement'.

Don't forget to give the project a star! Thanks again!

👏 Acknowledgments

Inspiration, code snippets, etc.

(back to top)