A command line tool to fetch worldwide data about COVID-19.

Stay Home, Stay Safe.

coronapy-cli

Track the Coronavirus disease (COVID-19) in the command line.

🚀 Get worldwide Coronavirus disease (COVID-19) reporting
🤯 Active daily reporting of your country's COVID-19 statistics
🗃️ Data: Country, Cases, Deaths, Recovered, Active, Critical
🥃 Soon : Get Mroccan States data for Coronavirus disease reports

Data Source

NovelCOVID/API updated very frequently.

Install

pip install coronapy-cli

Project Structure

├───.github
├───coronapy
│    ├───lib
│    │   ├───__init.py__
│    │   ├───color.py
│    │   ├───get_countries.py
│    │   ├───get_country.py
│    │   └───get_world_wide.py
│    ├───__init__.py
│    └───cli.py
├───.gitignore
├───LICENSE.txt
├───Pipfile
├───Pipfile.lock
├───READMR.md
├───setup.cfg
└───setup.py

Development

Setup

Clone the repo and cd into it.

Set up a Python 3 virtual environment using pipenv:

pipenv --three         # create Python 3 virtual environment
pipenv install --dev   # install all dependencies
pipenv shell           # activate virtual environment shell

The script can be run from the root directory of the project:
```
python3 -m coronapy.cli --help
```

Usage

Worldwide Information

# Display data for all total cases, recovery, and deaths.
coronapy all

# Display a chart of Total Cases, Total Deaths and Recovered Cases.
coronapy all --chart

# Alias: Display  a char.
coronapy all -c

All Countries

# Display data for all countries.
coronapy countries

# Sort data by type, the default type is 'cases'.
coronapy countries --sort cases

# Alias: Sort data by type.
corcoronapyona countries -s recovered

# limit the number of results to the specified value.
coronapy countries --limit 5  

# Alias: limit the number of results .
coronapy countries -l 5

Single Country

# Display data for given country.
coronapy country <country_name>

# Display a chart of Total Cases, Total Deaths and Recovered Cases for given country i.e. China.
coronapy country China --chart

# Alias: Display  a char.
coronapy country China -c

# Display a histogram shows cases or deaths data in last 20 day for given country i.e. USA.
coronapy country usa --hist

# You can set what kind of data (cases or deaths), the default is 'cases'.
coronapy country usa --hist --type cases
coronapy country usa --hist --type deaths

# Alias: Histogram & data type.
coronapy country usa -h -t cases

Sort Data

# All sorting parameters.
coronapy countries -s country
coronapy countries -s cases
coronapy countries -s todayCases
coronapy countries -s deaths
coronapy countries -s todayDeaths
coronapy countries -s recovered
coronapy countries -s active
coronapy countries -s critical

CLI Help

# Display the help data.
coronapy --help

To Do

~~Add Screenshots.~~
~~Catch and handle exceptions.~~ (Complete)
~~Make --help command better.~~
Add Mroccan States data for Coronavirus disease reports.
Add US States data for Coronavirus disease reports.
Testing code.
More Code Refactor!
More... (have suggestions? let me know!)

Issues

If you're facing a problem in using coronapy-cli please let me know by creating an issue in this github repository. I'm happy to help you! Don't forget to provide some screenshot or error logs of it!

Contributing

Contributions are welcome, create a pull request to this repo and I will review your code.

Contributors list

_{Mouad Boulahdoud}	_{Misha Lisovyi}	_aymaneMx	_{Mouad ZIANI}	_Amitay	_kudos	_OkiStuff	_{Jose M. Segura Polanco}
_{Yasser Tahiri}

Authors

MouadBH

License

This project is licensed under the MIT License - see the LICENSE.txt file for details

Sponsor

This project sponsored by tea 🥃.

Usage of ISO codes

Great tool for python users! Thanks for introducing it.

The country endpoint of NovelCOVID/API supports usage of ISO codes for contries, e.g. DE/DEU for Germany. However, their historical endpoint does not support ISO codes as inputs :(. For this cli tool this means, that the country info is extracted also with the short ISO code instead of the full name, but the histogram works only with the full name . The histogramming part should catch such problem at the very least or try converting ISO codes into full name at best.

Example:

$ coronapy country de -h -t cases
...
Civid-19 'cases' for last 20 day in de.
Traceback (most recent call last):
  File "xxx/anaconda3/bin/coronapy", line 10, in <module>
    sys.exit(cli())
  File "xxx/anaconda3/lib/python3.6/site-packages/click/core.py", line 722, in __call__
    return self.main(*args, **kwargs)
  File "xxx/anaconda3/lib/python3.6/site-packages/click/core.py", line 697, in main
    rv = self.invoke(ctx)
  File "xxx/anaconda3/lib/python3.6/site-packages/click/core.py", line 1066, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "xxx/anaconda3/lib/python3.6/site-packages/click/core.py", line 895, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "xxx/anaconda3/lib/python3.6/site-packages/click/core.py", line 535, in invoke
    return callback(*args, **kwargs)
  File "xxx/anaconda3/lib/python3.6/site-packages/coronapy/cli.py", line 114, in country
    tg.chart(colors=[91, 94], data=hist_data, args=args, labels=labels_hist)
  File "xxx/anaconda3/lib/python3.6/site-packages/termgraph/termgraph.py", line 353, in chart
    len_categories = len(data[0])
IndexError: list index out of range

Used Corona-cli v1.2.3

mouadbh / coronapy-cli Goto Github PK

coronapy-cli's Introduction

A command line tool to fetch worldwide data about COVID-19. Stay Home, Stay Safe.

coronapy-cli

Data Source

Install

Project Structure

Development

Setup

Usage

Worldwide Information

All Countries

Single Country

Sort Data

CLI Help

To Do

Issues

Contributing

Contributors list

Authors

License

Sponsor

coronapy-cli's People

Contributors

Stargazers

Watchers

Forkers

coronapy-cli's Issues

Recommend Projects

Recommend Topics

Recommend Org

A command line tool to fetch worldwide data about COVID-19.

Stay Home, Stay Safe.