# fcall

> Parse Farm Credit Administration (FCA) Call Report data into tidy Polars data frames

## Docs

### API Reference

#### Core API
> The three user-facing functions that mirror the R {fcall} package.

- [download_data](https://ketchbrookanalytics.github.io/fcall-py/reference/download_data.html): Download a quarter's FCA Call Report archive and unzip into *dest*
- [process_data](https://ketchbrookanalytics.github.io/fcall-py/reference/process_data.html): Read a quarter's downloaded .TXT files into tidy Polars DataFrames
- [compare_metadata](https://ketchbrookanalytics.github.io/fcall-py/reference/compare_metadata.html): Diff the metadata (D_*.TXT) files between two quarter directories

#### Lower-level helpers
> Exported for power users who need fine-grained control over parsing. Most users should call ``process_data()`` instead.


- [process_metadata_file](https://ketchbrookanalytics.github.io/fcall-py/reference/process_metadata_file.html): Parse a metadata (D_*.TXT) file into a scenario + vars_info dict
- [process_data_file](https://ketchbrookanalytics.github.io/fcall-py/reference/process_data_file.html): Read *file* and return a tidy DataFrame using *metadata* and *codes_dict*
- [read_data_file](https://ketchbrookanalytics.github.io/fcall-py/reference/read_data_file.html): Low-level reader: returns an unnamed DataFrame matching the raw CSV shape
- [get_codes_dict](https://ketchbrookanalytics.github.io/fcall-py/reference/get_codes_dict.html): Return the codes dictionary for *data_name*, or ``None`` values if none
- [compare_files_content](https://ketchbrookanalytics.github.io/fcall-py/reference/compare_files_content.html): Return unified-diff lines between *filename* in *dir1* and *dir2*

#### Data assets
> Internal datasets shipped with the package. ``fcall.file_metadata`` is a Polars DataFrame (36 rows) mapping file prefixes to descriptions — access it directly. ``get_code_df`` returns a code-to-label DataFrame for datasets that have repeating code groups.


- [get_code_df](https://ketchbrookanalytics.github.io/fcall-py/reference/get_code_df.html): Return a DataFrame[code: Int64, value: Utf8] for *registry_key*