https://github.com/m97chahboun/django_kpi
Django package designed to create flexible Key Performance Indicators (KPIs) for your projects. This package allows you to define, track, and manage KPIs with ease.
https://github.com/m97chahboun/django_kpi
dashboard django django-admin django-admin-panel django-dashboard kpi
Last synced: 5 months ago
JSON representation
Django package designed to create flexible Key Performance Indicators (KPIs) for your projects. This package allows you to define, track, and manage KPIs with ease.
- Host: GitHub
- URL: https://github.com/m97chahboun/django_kpi
- Owner: M97Chahboun
- Created: 2025-01-12T17:05:17.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-22T18:05:57.000Z (5 months ago)
- Last Synced: 2025-01-22T18:16:19.868Z (5 months ago)
- Topics: dashboard, django, django-admin, django-admin-panel, django-dashboard, kpi
- Language: Python
- Homepage: https://pypi.org/project/django-kpi/
- Size: 82 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# django_kpi
> ⚠️ **Note:** This package is currently in active development.
`django_kpi` is a Django package designed to create flexible Key Performance Indicators (KPIs) for your projects. This package allows you to define, track, and manage KPIs with ease.
## Features
- Define custom KPIs
- Track KPI performance over time (WIP)
- Flexible configuration options
- Easy integration with existing Django projects
## Installation
To install `django_kpi`, use pip:
```bash
pip install django_kpi
```
## Usage
1. Add `django_kpi` to your `INSTALLED_APPS` in your Django settings:
```python
INSTALLED_APPS = [
...
'django_kpi',
]
```
2. Update your `urls.py` to include the `django_kpi` URLs:
```python
from django.urls import path, include
urlpatterns = [
...
path('kpi/', include('django_kpi.urls')),
]
```
3. Run the migrations to create the necessary database tables:
```bash
python manage.py migrate
```
4. Define your KPIs in the Django admin interface or through the provided API.
5. Use KpiCards on your views check [example](./django_kpi_example/kpi_example/views.py)
## Screenshots
### Input
### Output
## Contributing
Contributions are welcome! Please submit a pull request or open an issue to discuss your ideas.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
For questions or support, please contact [[email protected]](mailto:[email protected]).