API Reference¶
This page provides complete API documentation for all workspace packages, generated from source code docstrings.
Overview¶
The nj_legislature workspace consists of three main packages:
- njleg_api: Main API client for interacting with the NJ Legislature API
- bills: Bill data management and processing utilities
- core: Shared utilities and logging configuration
njleg_api Package¶
The primary package for interacting with the New Jersey Legislature's API.
Main Client¶
::: njleg_api.client.APIClient options: show_source: true show_bases: false heading_level: 4
Cache Management¶
::: njleg_api.cache_management.CacheManager options: show_source: true show_bases: false heading_level: 4
Configuration¶
::: njleg_api.config options: show_source: false show_bases: false members: - setup_package_logging - get_logger - set_global_log_level heading_level: 4
Endpoints¶
Bill Detail¶
::: njleg_api.endpoints.bill_detail.BillDetailEndpoints options: show_source: false show_bases: false heading_level: 5
Budget¶
::: njleg_api.endpoints.budget.GovernorsBudgetEndpoints options: show_source: false show_bases: false heading_level: 5
::: njleg_api.endpoints.budget.BudgetFinanceEndpoints options: show_source: false show_bases: false heading_level: 5
::: njleg_api.endpoints.budget.BudgetResolutionsEndpoints options: show_source: false show_bases: false heading_level: 5
Committee¶
::: njleg_api.endpoints.committee.CommitteeInfoEndpoints options: show_source: false show_bases: false heading_level: 5
Districts¶
::: njleg_api.endpoints.districts.DistrictsEndpoints options: show_source: false show_bases: false heading_level: 5
Legislator¶
::: njleg_api.endpoints.legislator.LegislatorDataEndpoints options: show_source: false show_bases: false heading_level: 5
Reports¶
::: njleg_api.endpoints.reports.LegislativeReportsEndpoints options: show_source: false show_bases: false heading_level: 5
Video Retrieval¶
::: njleg_api.endpoints.video_retrieval.VideoRetrievalEndpoints options: show_source: false show_bases: false heading_level: 5
Additional Endpoints¶
::: njleg_api.endpoints.additional.LegislativeCommissionsEndpoints options: show_source: false show_bases: false heading_level: 5
::: njleg_api.endpoints.additional.VotingRecordsEndpoints options: show_source: false show_bases: false heading_level: 5
::: njleg_api.endpoints.additional.PublicHearingsEndpoints options: show_source: false show_bases: false heading_level: 5
::: njleg_api.endpoints.additional.PropertyTaxReformEndpoints options: show_source: false show_bases: false heading_level: 5
Models¶
Bill Detail Models¶
::: njleg_api.models.bill_detail options: show_source: false show_bases: false heading_level: 5
Budget Models¶
::: njleg_api.models.budget options: show_source: false show_bases: false heading_level: 5
Committee Models¶
::: njleg_api.models.committee options: show_source: false show_bases: false heading_level: 5
Districts Models¶
::: njleg_api.models.districts options: show_source: false show_bases: false heading_level: 5
Legislator Models¶
::: njleg_api.models.legislator options: show_source: false show_bases: false heading_level: 5
Reports Models¶
::: njleg_api.models.reports options: show_source: false show_bases: false heading_level: 5
Video Retrieval Models¶
::: njleg_api.models.video_retrieval options: show_source: false show_bases: false heading_level: 5
Additional Models¶
::: njleg_api.models.additional options: show_source: false show_bases: false heading_level: 5
CLI¶
::: njleg_api.cli.main options: show_source: false show_bases: false heading_level: 4
bills Package¶
Bill data management and processing utilities.
Bill Data Management¶
::: bills.BillData options: show_source: true show_bases: false heading_level: 4
Configuration¶
::: bills.config options: show_source: false show_bases: false heading_level: 4
core Package¶
Core utilities shared across the workspace.
Logging¶
::: core.logging options: show_source: true show_bases: false heading_level: 4
Configuration¶
::: core.config options: show_source: false show_bases: false heading_level: 4