Changelog#

All notable changes to FedFred will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased #

Added#

Complete testing suite

[2.1.0] - 2025-04-30#

Added#

Added more testing classes (still incomplete)

Fixed#

Rebuilt documentation using pydata sphinx theme
Added better documentnation pages with dynamic elements
Reindexing with Bing Webmaster, Index Now, annd Google Search Console
Logic fixes for parameter validation
Nested methods for FredHelpers class refactored

2.0.9 - 2025-04-14 (PUBLISHING FIX)#

2.0.8 - 2025-04-14 (YANKED)#

2.0.7 - 2025-04-14 (YANKED)#

2.0.6 - 2025-04-14 (YANKED)#

2.0.5 - 2025-04-14 (YANKED)#

2.0.4 - 2025-04-14 (YANKED)#

2.0.3 - 2025-04-14 (YANKED)#

2.0.2 - 2025-04-14 (YANKED)#

2.0.1 - 2025-04-14 (YANKED)#

2.0.0 - 2025-04-14#

Added#

clients_property_based_test.py
objects_property_based_test.py
helpers_test.py
helpers_property_based_test.py
Type annotations directly in source code
More comprehensive error handling for all methods
asyncache dependency for cachetools async decorator
README.md badges for ‘in repositories’ and ‘Socket’
Optional DataFrame support for dask
OpenSSF Silver & Gold
DCO.md
ROADMAP.md
helper methods now housed in helpers.py FredHelpers class
polars dependency moved to extra dependency group
dunder methods for all classes
appropriate dunder modules and corresponding precommit hooks/scripts
polars-st added to polars dependency group for polars geodataframes
layout.html
BingSiteAuth.xml
/conda-forge/meta.yaml

Removed#

.pyi type stub files
‘file_type’ arg for all methods (will only support JSON)
update_fedstock.py

Fixed#

Caching logic rework for better type annotations and execution
Cache type changed from TTL to FIFO
Error handling logic moved to private helper method.
Async helper method logic rework to reduce boilerplate code
Date args now accept datetime objects
Semicolon-seperated string args now accept list objects
Dataclass object outputs simplified and output types adjusted accordingly
Dataclass objects now have async methods
fedfred.py renamed to clients.py
fred_data.py renamed to objects.py
fedfred_test.py renamed to clients_test.py
fred_data_test.py renamed to objects_test.py
update_feedstock.yml merged into main.yml
tox.ini config fixed
conf.py

1.2.9 - 2025-03-20#

Added#

Added codecov
Conda-forge packaging and distribution
Documentation for Anaconda

Changed#

main.yml updated for conda

1.2.8 - 2025-03-20#

Changed#

Moved type hinting and stub packages to optional dependency group
Duplicated type packages in dev dependencies
tox.ini adjusted

1.2.7 - 2025-03-20#

Added#

cachetools (prepping for conda release)
types-cachetools
scripts/sync_conda_recipe.py

Changed#

test.yml dropped linting, type-checking, and security analysis, (analyze.yml already does this.)
“test-coverage.yml” merged into test.yml
pre-commit-config.yaml updated for conda

Removed#

cacheout dependency due to conda issue

1.2.6 - 2025-03-19#

Fixed#

publishing patch for toml version error

1.2.5 - 2025-03-19#

Fixed#

publishing patch for gpg keys

1.2.4 - 2025-03-19#

Changed#

“sign-release.yml” merged into main.yml

Fixed#

test coverage error due to missing async dependency

1.2.3 - 2025-03-19#

Fixed#

Minor workflow config patch

1.2.2 - 2025-03-19#

Added#

tox.ini
test-coverage.yml
Dev dependency: tox
Dev dependency: pytest-asyncio
Dev dependency: pytest-mock

Changed#

1.2.1 - 2025-03-15#

Added#

Google analytics tag for sphinx
Dev dependency ‘sphinxcontrib.googleanalytics’

1.2.0 - 2025-03-14#

Added#

FredAPI.Maps subclass
FredAPI.Async subclass
FredAPI.Async.Maps subclass
cacheout dependency
fred_data_test.py

Fixed#

Async logic (asyncio.run cannot be called within a loop)
Caching logic

Deprecated#

async_mode -> bool for all classes
FredMapsAPI class
typed-diskcache dependency

1.1.0 - 2025-03-12#

Added#

Sphinx Documentation Structure Created
Documentation Workflow (Github Pages)
Docs Workflow
CONTRIBUTIONS.md
SECURITY.md
CODE_OF_CONDUCT.md
CHANGELOG.md
bug_report.md
feature_report.md
GPG Key file
Sign-Release Workflow
OpenSSF Passing
Full conversion to poetry
Added dev dependencies
pre-commit-config.yaml for devs

Changed#

README.md sections
CodeQL schedule changed to daily

Removed#

setuptools backend

Fixed#

PEP257 compliance for docstrings

1.0.26 - 2025-03-11#

Fixed#

minor functionality patch

1.0.25 - 2025-03-11 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.24 - 2025-03-11 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.23 - 2025-03-11 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.22 - 2025-03-11 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.21 - 2025-03-11 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.20 - 2025-03-11 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.19 - 2025-03-11 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.18 - 2025-03-11 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.17 - 2025-03-11 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.16 - 2025-03-11 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.15 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.14 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.13 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.12 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.11 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.10 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.9 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.8 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.7 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

[1.0.6] - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.5 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.4 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.3 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.2 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.1 - 2025-03-10 (YANKED RELEASE)#

Fixed#

minor functionality patch

1.0.0 - 2025-03-10#

Added#

polars output
pandas output
geopandas output
Type stubs (fedfred.pyi, fred_data.pyi, init.pyi)
Local caching (typed-diskcache)
Async support (httpx)
Rate limiter (tenacity)
Data Classes for Method Outputs (fred_data.py module)
Unit Testing (_test.py)
Analyze workflow (analyze.yml)
CodeQl workflow ([codeql.yml])(nikhilxsunder/fedfred)
Testing Workflow ([test.yml])(nikhilxsunder/fedfred)
Logo Image
init.py import all
Import dataclasses in init.py:
Mypy type stub recognition (py.typed)

Changed#

README.md sections
Package description (now “feature-rich” instead of “simple”)
Package backwards compatible to Python >= 3.7
Api request library in favor of httpx
Documentation link

Removed#

requests dependency

Fixed#

init.py module docstring

0.0.7 - 2025-01-29#

Changed#

Version bump for publishing error.

[0.0.6] - 2025-01-29 (DELETED RELEASE)#

Fixed#

Issue with incorrect import syntax in init.py

0.0.5 - 2025-01-29#

Added#

“Latest Update” in README.md
FredMapsAPI Class for interacting with GeoFred
Methods for FredMapsAPI
Class and Method docstrings for FredMapsAPI Class
FredMapsAPI Class importable in init.py

Changed#

“Installation” in README.md

0.0.4 - 2025-01-29#

Changed#

Version bump for publishing error

Added#

0.0.3 - 2025-01-19#

Added#

Added methods to FredAPI class to interact with all endpoints
Completed Class, Method, and Module Docstrings
Populated README.md

0.0.2 - 2025-01-17#

Added#

FredAPI Class
Method structure notes in fedfred.py
README.md Badges
Main publishing worklow

[0.0.1] - 2025-01-16 (DELETED RELEASE)#

Added#

Initial pre-release of fedfred
Core functionality for making api requests
License file
README.md
fedfred.py
init.py
requests dependency
pyproject.toml
initial directory structure
setuptools for build backend