iyedg / e_istichara_monitor

A Python script to monitor the progress of the indicators of the Tunisian National Consultation of 2022

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Stargazers Issues The Unlicense License LinkedIn


e-istichara Monitor


Report Bug · Request Feature

Product Name Screen Shot

About The Project

This is a simple Python Script that was written to monitor the progress of official indicators of the Tunisian National Consultation of 2022. The official website https://www.e-istichara.tn relies on a JSON API. This script calls that API periodically to save the indicators displayed on the website. As of now, the consultation was concluded on the 20th of March, 2022, therefore this code is shared for posterity's sake. The actual data collected is available upon request.

(back to top)

Built With

(back to top)

Getting Started

The environment necesseary for running this project requires at least Python 3.10 . I recommend using a tool like pyenv to manage your Python versions.

If you are using poetry, simply change your directory to the root of this project, and run the following command

poetry install

which will manage your virtual environment and the installation of the libraries inside of it for you.

If you wish to use pip instead, please make sure to create a separate virtual environment and then run the following command in the activated virtual environment

python -m pip install -r requirements.txt

(back to top)

Usage

To run this tool, simply run the following command.

python e_istichara_monitor/istichara.py

(back to top)

Requesting the Data

If you wish to access the data collected by this script, please send me an email on contact@iyedg.me. If you create something using this data, please credit this work properly.

(back to top)

Where has this been used ?

A list of places where the data generated from this script was used:

Licenses

Code

Distributed under the Unlicense License. See UNLICENSE.txt for more information.

Data

The data collected by this work by Iyed Ghedamsi is licensed under CC BY-NC 4.0

For a Human readable version of this license see this link. See BY-NC.txt for more information.

(back to top)

About

A Python script to monitor the progress of the indicators of the Tunisian National Consultation of 2022

License:The Unlicense


Languages

Language:Python 100.0%