popgetter-cli

Library and associated command-line application for exploring and fetching popgetter data.

Quickstart

• Install Rust
• Install CLI:

  cargo install popgetter-cli

• Run the CLI with e.g.:

  popgetter --help

About the data

The data used by popgetter is collated into a format ready for use, by a tool called poppusher. See that tool for details about which data is available.

Popgetter and Poppusher version compatibility

Each version of popgetter-core is tied to one specific version of poppusher to ensure consistency of data types. Changes to popgetter-core may require changes to downstream dependents. (Note that updates to the actual data and metadata themselves do not lead to a version bump.)

poppusher	popgetter-core	popgetter-cli	popgetter-py
0.1.0	N/A	N/A	N/A
0.2.0	0.2.0	0.2.0	0.2.0
0.2.0	0.2.1	0.2.1	0.2.1
...	...

Developer guide

Editable install from source

• Install Rust
• Clone the repo:

  git clone git@github.com:Urban-Analytics-Technology-Platform/popgetter.git
  cd popgetter

• Build:

  cargo build

  and in release mode:

  cargo build --release

• Run the CLI with e.g.:

  cargo run --bin popgetter -- --help

Release process

The release process in managed by the release-plz GitHub Action (workflow).

Note: the popgetter-py module is deployed to PyPI at the earilest opportunity (eg when a PR is created which bumps the version number). However it is not deployed to crates.io until that PR is merged to main.