Caribbean Outbreak Tracker

Introduction

Django package for tracking pandemic outbreaks in the Caribbean. Based on previous project for tracking COVID-19 across the Caribbean (https://github.com/obikag/caribbean-virus-tracker/).

Website based on this project can be found here: https://caribbeanvirustracker.com/

Installation

Pip

Use the Python package manager pip to install the package and dependencies.

pip install caribbean-outbreak-tracker

GitHub Repo

Clone the repo and navigate to the working directory.

git clone https://github.com/obikag/caribbean-outbreak-tracker.git
cd caribbean-outbreak-tracker

Using setuptools install the package and dependencies.

python setup.py install

Usage

Create a Django project and navigate to working directory.

django-admin startproject example-site
cd example-site

Add the outbreak tracker app to you settings.py file

INSTALLED_APPS = [
    ...,
    'outbreak_tracker',
]

Make migrations and migrate changes to the database

python manage.py makemigrations
python manage.py migrate

Navigate to the project's admin site to access the models and enter the relevant information.

Documentation

Documentation can be found here:

https://caribbean-outbreak-tracker.readthedocs.io/en/latest/

Testing

Coming Soon

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Prior to contributing to this project, kindly read the code of conduct.

License

MIT