https://github.com/immunant/fastfec-rust

C2Rust transpiled version of FastFEC
https://github.com/immunant/fastfec-rust

Last synced: 12 days ago
JSON representation

C2Rust transpiled version of FastFEC

• Host: GitHub
• URL: https://github.com/immunant/fastfec-rust
• Owner: immunant
• License: mit
• Created: 2022-07-08T22:30:07.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-12T14:19:21.000Z (over 2 years ago)
• Last Synced: 2024-11-07T13:13:22.698Z (2 months ago)
• Language: Rust
• Size: 51.8 KB
• Stars: 1
• Watchers: 8
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FastFEC-rust

A machine-translated version of [FastFEC](https://github.com/washingtonpost/FastFEC) using the [`c2rust`](https://github.com/immunant/c2rust) tool.

## Adaptation of `FastFEC` README:

A Rust program to stream and parse FEC filings, writing output to CSV.

## Installation

`cargo install --path .`

## Usage

Once FastFEC has been installed, you can run the program by calling `fastfec` in your terminal:

```

Usage: fastfec [flags]  [output directory=output] [override id]

```

- `[flags]`: optional flags which must come before other args; see below

- `` is either

  - a numeric ID, in which case the filing is streamed from the FEC website

  - a file, in which case the filing is read from disk at the specified local path

  - a url, in which case the filing is streamed from the specified remote URL

- `[output directory]` is the folder in which CSV files will be written. By default, it is `output/`.

- `[override id]` is an ID to use as the filing ID. If not specified, this ID is pulled out of the first parameter as a numeric component that can be found at the end of the path/URL.

The CLI will download or read from disk the specified filing and then write output CSVs for each form type in the output directory. The paths of the outputted files are:

- `{output directory}/{filing id}/{form type}.csv`

You can also pipe the output of another command in by following this usage:

```

[some command] | fastfec [flags]  [output directory=output]

```

### Flags

The CLI supports the following flags:

- `--include-filing-id` / `-i`: if this flag is passed, then the generated output will include a column at the beginning of every generated file called `filing_id` that gets passed the filing ID. This can be useful for bulk uploading CSVs into a database

- `--silent` / `-s` : suppress all non-error output messages

- `--warn` / `-w` : show warning messages (e.g. for rows with unexpected numbers of fields or field types that don't match exactly)

- `--no-stdin` / `-x`: disable receiving piped input from other programs (stdin)

The short form of flags can be combined, e.g. `-is` would include filing IDs and suppress output.

### Examples

`fastfec -s 13360 fastfec_output/`

- This will run FastFEC in silent mode, download and parse filing ID 13360, and store the output in CSV files at `fastfec_output/13360/`.