https://github.com/areed1192/us-federal-register-python-api
A python API client for the United States Federal Register.
https://github.com/areed1192/us-federal-register-python-api
api api-client federal-register python
Last synced: about 1 year ago
JSON representation
A python API client for the United States Federal Register.
- Host: GitHub
- URL: https://github.com/areed1192/us-federal-register-python-api
- Owner: areed1192
- License: mit
- Created: 2020-08-11T23:36:57.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-12T18:23:41.000Z (almost 6 years ago)
- Last Synced: 2025-04-07T08:45:20.660Z (over 1 year ago)
- Topics: api, api-client, federal-register, python
- Language: Python
- Homepage:
- Size: 449 KB
- Stars: 9
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Federal Register Python API Client
## Table of Contents
- [Overview](#overview)
- [Setup](#setup)
- [Usage](#usage)
- [Support These Projects](#support-these-projects)
## Overview
This library is used to grab federal documents from the United States Federal Register.
Additionally, it will help simplify the process of building requests for the different
fields that can be returned for specific documents.
## Setup
To **install** the library, run the following command from the terminal.
```console
pip install federal-register
```
To **upgrade** the library, run the following command from the terminal.
```console
pip install --upgrade federal-register
```
## Usage
Here is a simple example of using the `federal_register` library to grab a document
using the document number.
```python
from pprint import pprint
from federal_register.client import FederalRegister
# Initialize the client.
federal_register_client = FederalRegister()
# Grab a specific document.
federal_document = federal_register_client.document_by_id(
document_id='2020-17469',
fields='all'
)
# Print it out.
pprint(federal_document)
```
## Support These Projects
**Patreon:**
Help support this project and future projects by donating to my [Patreon Page](https://www.patreon.com/sigmacoding)
. I'm always looking to add more content for individuals like yourself, unfortuantely some of the APIs I would require
me to pay monthly fees.
**YouTube:**
If you'd like to watch more of my content, feel free to visit my YouTube channel [Sigma Coding](https://www.youtube.com/c/SigmaCoding).