pytimeliner 0.1

Create a timeline by listing events with multilingual support.

PyTimeliner

PyTimeliner is a Python package for organizing events and dates in a chronological timeline with multilingual support. This package enables you to add events in various languages and create a well-ordered timeline.

Features

• Add and display events in different languages
• Automatically organizes events in chronological order
• Useful for developers working on event-based projects

Installation

Using setup.py

First, clone the repository and navigate to the project directory. Then, install the package with:

pip install -e .

Using requirements.txt

Alternatively, if you want to install dependencies separately, you can create a requirements.txt file. Install the package dependencies with:

pip install -r requirements.txt

This package uses googletrans for translation support. If you are using requirements.txt, make sure it contains:

googletrans==4.0.0-rc1

Usage

Using PyTimeliner, you can easily add events and display them in a timeline format.

Example Usage

from pytimeliner.timeliner import Timeliner

# English timeline
timeline = Timeliner(language='en')
timeline.add_event("2024-01-01", "New Year")
timeline.add_event("2024-12-25", "Christmas")
timeline.display_timeline()

# Spanish timeline
timeline_es = Timeliner(language='es')
timeline_es.add_event("2024-01-01", "New Year")
timeline_es.add_event("2024-12-25", "Christmas")
timeline_es.display_timeline()

Output

English:

2024-01-01: New Year
2024-12-25: Christmas

Spanish:

2024-01-01: Año Nuevo
2024-12-25: Navidad

Running Tests

To run tests, use the tests folder which contains test files:

python -m unittest discover -s tests

Contributing

If you want to contribute, feel free to open an issue or submit a pull request. All contributions are welcome!