polcli
TypeScript icon, indicating that this package has built-in type declarations

0.0.5 • Public • Published

polcli

A set of political data-mining tools wrapped in a handy CLI (pronounced pol-sly)

Version CircleCI

Goals of this project (perpetually unchecked, because we can always do better):

  • Provide lower barrier to accessing raw data relating to elections (FEC in particular)
  • Provide basic statistical aggregation of election data (specifically relating to party and financial data)

Usage

$ npm install -g polcli
$ polcli COMMAND
running command...
$ polcli (-v|--version|version)
polcli/0.0.5 win32-x64 node-v8.9.4
$ polcli --help [COMMAND]
USAGE
  $ polcli COMMAND
...

Commands

analyze:summary

analyze US House and Senate elections

USAGE
  $ polcli analyze:summary

OPTIONS
  -H, --excludeHouse       exclude House data in analysis
  -P, --excludePresident   exclude Presidential data in analysis
  -S, --excludeSenate      exclude Senate data in analysis
  -f, --filename=filename  JSON file to read election data from

See code: src/commands/analyze/summary.ts

download:fec FILENAME

download FEC campaign data for a given year and outputs it as JSON

USAGE
  $ polcli download:fec FILENAME

ARGUMENTS
  FILENAME  filename to write JSON to

OPTIONS
  -y, --year=year  [default: 2018] year(s) to download data for (comma-separated)

See code: src/commands/download/fec.ts

help [COMMAND]

display help for polcli

USAGE
  $ polcli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

Readme

Keywords

Package Sidebar

Install

npm i polcli

Weekly Downloads

0

Version

0.0.5

License

MIT

Unpacked Size

31.4 kB

Total Files

33

Last publish

Collaborators

  • aldahick