[go: up one dir, main page]

Skip to content

Python library for scraping the web for events that happened on current day, from multiple online sources

License

Notifications You must be signed in to change notification settings

bit97/onthisday

Repository files navigation

onthisday

DeepSource DeepSource

Code style: black Imports: isort

Simple library that retrieves the historical events that happened on current day.

At the moment the events do not include birth/death of famous people.

Event sources

  • Wikipedia 🇮🇹🇺🇸🇬🇧🇫🇷🇩🇪🇪🇸🇵🇹 (other countries may work, not tested)
  • Accadde Oggi 🇮🇹

Install

pip install onthisday

Usage

As a standalone script

In the root directory:

> python -m onthisday --help

Usage: main.py [OPTIONS] COMMAND [ARGS]...

Commands:
  all     Print all the events of today
  last    Print last n events of today
  list    List the available sources (valid shorter names in brackets)
  random  Print random event of today

For the specific command options:

> python -m onthisday all --help

Usage: main.py all [OPTIONS]

  Print all the events of today

Options:
  --source TEXT  [default: wiki]
  --locale TEXT
  --help         Show this message and exit.

As a library

see the example file provided

Possible usages

Shell greeting

Display a random event as the terminal emulator loads up.

For example, for the fish shell, one can add the following greeting function:

> function fish_greeting
      python -m onthisday random
  end

> funcsave fish_greeting

Close and reopen the terminal emulator and

[2005]  In Iraq inizia il processo all'ex-dittatore Saddam Hussein

~ via 🐍 v3.9.7 
➜ 

known issue: the script is not optimized and makes no use of caches. The user experience with this kind of greeting message might not be the best as the command will take around 1 second to run.

Issues

Please open issue on this GitHub repository for any error, suggestion or feature request.