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

coronapy-cli

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

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.
Add Mroccan States data for Coronavirus disease reports.
Add US States data for Coronavirus disease reports.
Testing code.
Make --help command better.
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

Authors

MouadBH

License

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

Sponsor

This project sponsored by tea 🥃.

mlisovyi / 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

coronapy-cli

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

Recommend Projects

Recommend Topics

Recommend Org

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

Stay Home, Stay Safe.