go-corona-go

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 25, 2020 License: Apache-2.0 Imports: 1 Imported by: 0

README

Go Corona Go :neckbeard:

Go Corona Go is a command line utility for getting information related to Covid-19 in India.

Installation

Installation can be done using the go get command which will take care of installation of any libraries and dependencies nescessary. This will also install the go-corona-go executable which can be used anywhere in the termnial provided $GOPATH/bin is in your PATH.

go get -u github.com/MadhavJivrajani/go-corona-go

Or you can clone this repository and work directly with the executable go-corona-go!

git clone https://github.com/MadhavJivrajani/go-corona-go.git

Usage

A command line utility for getting information related to Covid-19 in India.

Usage:
  go-corona-go [command]

Available Commands:
  district    Provides district-wise stats of a particular state for Covid-19 in India
  districts   Gets a list of valid districts of a particular state whose stats can be retreived
  help        Help about any command
  plot        Plots daily data about a particular statistic about Covid-19 in India
  sike        sike is sike
  state       Provides state wise stats of Covid-19 in India
  states      Gets a list of valid states whose stats can be retreived

Flags:
      --config string   config file (default is $HOME/.go-corona-go.yaml)
  -h, --help            help for go-corona-go
  -t, --toggle          Help message for toggle

Use "go-corona-go [command] --help" for more information about a command.
state command

This command information about a particular (valid) state.

Usage:

go-corona-go state [state]

Example:

go-corona-go state Karnataka

Result:

Info was last updated on: 22/07/2020 21:57:09

+--------------------------+-------+
|        KARNATAKA         |       |
+--------------------------+-------+
| Active cases             | 47066 |
| Confirmed cases          | 75833 |
| No. of deaths            |  1519 |
| No. of recoveries (yay!) | 27239 |
+--------------------------+-------+
district command

This command provides information for a particular (valid) district of a particular state.

Usage:

go-corona-go district [state] [district]

Example:

go-corona-go district maharashtra pune

Result:

Info was last updated on: 22/07/2020 21:57:05

+--------------------------+-------+
|           PUNE           |       |
+--------------------------+-------+
| Active cases             | 39353 |
| Confirmed cases          | 63351 |
| No. of deaths            |  1514 |
| No. of recoveries (yay!) | 22484 |
+--------------------------+-------+
states command

This command gives a list of valid states, in alphabetical order, whose data can be retreived.

Usage:

go-corona-go states
districts command

This command gives a list of valid distrcits of a valid state, in particular order, whose data can be retreived.

Usage:

go-corona-go districts [state]

Example:

go-corona-go distrcits karnataka
plot command

This command plots daily data about a particular type of data about Covid-19 in India. Plotting functionality is provided using the asciigraph library.

Usage:

go-corona-go plot -t [type]
[type]: confirmed (default), deaths, recovered

confirmed: plots trend of number of confirmed cases of Covid-19 in India each day
deaths : plots trend of number of deaths in India due to Covid-19 each day
recovered: plots trend of number of recoveries from Covid-19 in India each day

Example:

go-corona-go plot -t recovered

Result:

Plot information:
        IMPORTANT: This plot is intended to show ONLY the trend of data and should not be interpreted accurately

        X Axis: Dates starting from 30th January 2020.
        Y Axis: Number of recoveries from Covid-19 in India.
 31875 ┼                                                              ╭ 
 30281 ┤                                                              │ 
 28688 ┤                                                              │ 
 27094 ┤                                                              │ 
 25500 ┤                                                              │ 
 23906 ┤                                                            ╭╯ 
 22312 ┤                                                            │  
 20719 ┤                                                          ╭╯  
 19125 ┤                                                       ╭─╯   
 17531 ┤                                                       │     
 15938 ┤                                                       │     
 14344 ┤                                             ╭╮╭╮ ╭╯     
 12750 ┤                                             │ ╰╯╰╯      
 11156 ┤                                             │          
  9562 ┤                                             │          
  7969 ┤                                        ╭╮  |          
  6375 ┤                                  ╭╮ ╭╯ ╰╯          
  4781 ┤                                  │ ╰─╯             
  3188 ┤                             ╭───╯                
  1594 ┤                         ╭───╯                    
     0 ┼─────────────────────────╯                        
          A plot showing the trend of the number of deaths due to Covid-19 per day.

sike command

I love this command 👀
It will display one of three different messages everytime it is called, feel free to add more!

Usage

go-corona-go sike

Result:

Meet ken the chicken. ken crossed the road 'cause it ken.

    \\
    (o>
 \\_//)
  \_/_)
   _|_
   


This amazing ASCII art was taken from http://www.ascii-art.de/ascii/c/chicken.txt

(there are two more messages like this one XD)

Credits:

  • The API used to get information can be found here.
  • The cobra library was used to develop the CLI.
  • The tablewriter library was used to format and print the data in a tabular form.
  • The asciigraph library was used to provide in-terminal plotting functionality.

Documentation

Overview

Copyright © 2020 Madhav Jivrajani [email protected]

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL