Gem Version Open Source Helpers

If you're looking to consume this in your Ruby-based application, you might want to check Sarskov out. Sarskov returns statistics in a JSON format.

🦠 Kovid

Kovid is a small CLI app to fetch data surrounding the coronavirus pandemic of 2019. I found myself checking Wikipedia constantly for information so I thought I'd build this to provide info directly in the terminal. It's where some of us spend time more.

Code contribution and ideas welcome.

βš™οΈ Installation

To install:

  • ️ Wash your hands with soap and water for at least 20 seconds.

  • Run gem install kovid.

It's recommended you update often with gem update kovid.

βš’οΈ Usage

You can run kovid --help to see the full list of available commands.

Commands Overview

😷 Fetching

  • kovid check COUNTRY aliased as kovid country COUNTRY.
  • kovid check COUNTRY -f aliased as kovid country COUNTRY --full.

You can get continental information with the following commands:

  • kovid africa.
  • kovid europe.
  • kovid eu. (The European Union)
  • kovid sa. (South America)
  • kovid asia.
  • kovid world. (Worldwide Statistics)

πŸ‡ΊπŸ‡ΈπŸ‡ΊπŸ‡ΈπŸ‡ΊπŸ‡Έ

You can fetch US state-specific data:

  • kovid state STATE OR kovid state "STATE NAME".
  • kovid states --all or kovid states -a for data on all US states.

You can also use USPS abbreviations. Example: kovid state me

Provinces

You can fetch province specific data:

  • kovid province PROVINCE or kovid province "PROVINCE NAME".

😷 Comparing

  • kovid compare FOO BAR (sorts by cases DESC).
  • kovid compare FOO BAR -f OR kovid compare FOO BAR --full (sorts by cases DESC).

Where FOO and BAR are different countries.

You can compare as many countries as you want; kovid compare FOO BAR BAZ OR kovid compare FOO BAR BAZ -f

πŸ‡ΊπŸ‡ΈπŸ‡ΊπŸ‡ΈπŸ‡ΊπŸ‡Έ

You can compare US states with:

  • kovid states STATE STATE Example: kovid states illinois "new york" california OR kovid states il ny ca

You can compare provicnes with:

  • kovid provinces PROVINCE PROVINCE Example: kovid provinces ontario manitoba ___ 😷 History
  • kovid history COUNTRY (full history).
  • kovid history COUNTRY N (history in the last N days).
  • kovid history STATE --usa ___ 😷 Top N (by cases/deaths for countries and US States)
  • kovid top N (top N countries in number of cases).
  • kovid top N -d OR kovid top N --deaths (top N countries in number of deaths).
  • kovid top N --states (top N US states in number of cases).
  • kovid top N --states -d (top N countries in number of deaths). ___

NOTE: If you find it irritating to have to type kovid state STATE, covid state STATE works as well.

Commands Details

To fetch basic data on a country run:

kovid check ghana. If the location contains spaces: kovid check "Diamond Princess"

kovid

For full table info on a country:

kovid check italy -f OR kovid check italy --full

kovid

To compare country stats:

kovid compare germany poland spain

kovid

To compare a countries stats with a full table:

kovid compare poland italy usa china -f OR kovid compare poland italy usa china --full

kovid

To fetch state-specific data run:

kovid state colorado OR kovid state "north carolina"

kovid

To fetch EU data run:

kovid eu

kovid

To fetch data on Africa:

kovid africa

kovid

You can check historical statistics by running

kovid history italy 7 eg:

kovid

To check for total figures:

kovid world

kovid

To fetch top 5 countries in number of cases or deaths:

kovid top

kovid

kovid top --deaths OR kovid top -d

kovid

It is also possible to fetch top US states in number of cases or deaths:

kovid top --states

kovid

kovid top --states --deaths OR kovid top --states -d

kovid

To fetch more number of countries or US states you can pass N. eg:

kovid top 10

kovid

Data Source

JHU CSSE GISand Data and https://www.worldometers.info/coronavirus/ via NovelCOVID/API

πŸ‘¨β€πŸ’» Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. 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.

🀲 Contributing

There are multiple areas in this repo that can be improved or use some refactoring(there's a lot to be refactored in fact!). For that reason, bug reports and pull requests are welcome! 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 Kovid project's codebases and issue trackers is expected to follow the code of conduct.