historical-timelines 0.2.3

A Python package for making historical timelines

historical-timelines

Python package for creating timelines of historical events.

Overview

historical-timelines is a python package for creating nice looking timelines, specifically with historical data in mind. historical-timelines uses bokeh to create images.

Install

Install with pip install historical_timelines

Quick start

First, you'll need to import the HistoricalTimeline object.

from historical_timelines import HistoricalTimeline

Then, you need to populate it. Here's how to populate and display a random timeline:

from historical_timelines import HistoricalTimeline

timeline = HistoricalTimeline("Random Timeline")
timeline.populate_random_timeline()
timeline.render_timeline("timeline.html")

This will produce something that looks like this:

If you have a csv that you want to convert to a timeline, you can do that too. Suppose you have a csv with the path timeline.csv, and five columns entitled Name, Description, Label, Start, and End. It would be imported like this.

from historical_timelines import HistoricalTimeline

timeline = HistoricalTimeline("Timeline from my csv")
timeline_json = HistoricalTimeline.json_from_csv(
    "timeline.csv",
    "Name",
    "Description",
    "Label",
    "Start",
    "End",
)

timeline.populate_timeline_from_dict(timeline_json)
timeline.render_timeline("timeline.html")

Documentation

The documentation can be found here.

A jupyter tutorial can be found here.