BeaAsDataframe

Up to date remote economic data access for ruby, using Polars dataframes.

This package will fetch economic and financial information from the Bureau of Economic Analysis, and return the results as a Polars Dataframe. For some operations, you may need an API key that can be fetched from the BEA website at https://apps.bea.gov/API/signup/ .

Requirements: Ruby >= 3.3.0

Installation

Add this line to your application's Gemfile:

gem 'bea_as_dataframe'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install bea_as_dataframe

Requirements

• Ruby >= 3.3
• polars-df 0.27.1

Configuration

Some data sources will require the specification of an API key. These keys should be provided as part of a configuration file, e.g., config/bea_as_dataframe.rb

Operations in BeaAsDataframe::GdpPerCountySector require the specification of a directory for temporarily storing datafiles. See the following initialization snippet to provide that customization.

BeaAsDataframe.configure do |config|
  config.api_key = '1234567890ABCDEF'
    # OR
  config.api_key = File.read(File.join('','home', 'user', '.bea_api_key.txt'))

  config.tmp_dir = File.join('', 'tmp')
end

Usage

Fetch GDP per County and Sector Data

The BeaAsDataframe::GdpPerCountySector#fetch method downloads GDP data by county and sector from the BEA website and returns it as a Polars DataFrame.

require 'bea_as_dataframe'

# Configure the temporary directory (optional - defaults to /tmp)
BeaAsDataframe.configure do |config|
  config.tmp_dir = File.join('', 'tmp')
end

# Fetch the data
fetcher = BeaAsDataframe::GdpPerCountySector.new
df = fetcher.fetch

# The DataFrame contains GDP data by county and sector
# with columns like GeoFIPS, GeoName, Description, etc.
puts df.shape

The fetch method will raise a BeaAsDataframe::HTTPError if the download fails (e.g., HTTP 404 or other network errors).

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Testing

This project uses minitest for testing. Run the test suite with:

bundle exec rake test

All tests use mocked HTTP responses - no live BEA API calls are made during testing. This project does not use GitHub Actions for CI.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/bmck/bea_as_dataframe. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the BeaAsDataframe project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.