https://github.com/obikag/caribbean-outbreak-tracker
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-outbreak-tracker
caribbean caribbean-community coronavirus coronavirus-tracking django django-framework pandemic python3 tracker
Last synced: 7 months ago
JSON representation
Django package for tracking pandemic outbreaks in the Caribbean. Based on previous project for tracking COVID-19 across the Caribbean
- Host: GitHub
- URL: https://github.com/obikag/caribbean-outbreak-tracker
- Owner: obikag
- License: mit
- Created: 2020-08-07T22:49:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-15T09:01:40.000Z (over 1 year ago)
- Last Synced: 2025-04-28T09:55:12.412Z (7 months ago)
- Topics: caribbean, caribbean-community, coronavirus, coronavirus-tracking, django, django-framework, pandemic, python3, tracker
- Language: Python
- Homepage: https://caribbeanvirustracker.com/
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Caribbean Outbreak Tracker
[![forthebadge made-with-python][1]](https://www.python.org/)
[![python][2]](https://www.python.org/) [![Documentation Status][3]](https://caribbean-outbreak-tracker.readthedocs.io/en/latest/) [![MIT license][4]](https://lbesson.mit-license.org/)
## Introduction
Django package for tracking pandemic outbreaks in the Caribbean. Based on previous project for tracking COVID-19 across the Caribbean ().
Website based on this project can be found here:
## Installation
### Pip
Use the Python package manager [pip](https://pypi.org/project/pip/) to install the package and dependencies.
```bash
pip install caribbean-outbreak-tracker
```
### GitHub Repo
Clone the repo and navigate to the working directory.
```bash
git clone https://github.com/obikag/caribbean-outbreak-tracker.git
cd caribbean-outbreak-tracker
```
Using [setuptools](https://pypi.org/project/setuptools/) install the package and dependencies.
```bash
python setup.py install
```
## Usage
Create a [Django](https://www.djangoproject.com/) project and navigate to working directory.
```bash
django-admin startproject example-site
cd example-site
```
Add the outbreak tracker app to you settings.py file
```python
INSTALLED_APPS = [
...,
'outbreak_tracker',
]
```
Make migrations and migrate changes to the database
```bash
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:
## 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](https://caribbean-outbreak-tracker.readthedocs.io/en/latest/code_of_conduct.html).
## License
[MIT](https://choosealicense.com/licenses/mit/)
[1]: https://forthebadge.com/images/badges/made-with-python.svg
[2]: https://img.shields.io/badge/python-3.6-blue
[3]: https://readthedocs.org/projects/caribbean-outbreak-tracker/badge/?version=latest
[4]: https://img.shields.io/badge/License-MIT-blue.svg