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:

pip install django_kpi

Usage

Add django_kpi to your INSTALLED_APPS in your Django settings:

INSTALLED_APPS = [
    ...
    'django_kpi',
]

Update your urls.py to include the django_kpi URLs:

from django.urls import path, include

urlpatterns = [
    ...
    path('kpi/', include('django_kpi.urls')),
]

Run the migrations to create the necessary database tables:
```
python manage.py migrate
```
Define your KPIs in the Django admin interface or through the provided API.
Use KpiCards on your views check example

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 file for details.

Contact

For questions or support, please contact mchahboun@majaracapital.com.

Release files for django-kpi 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-kpi 1.0.0
File	Size	Uploaded
django_kpi-1.0.0.tar.gz	11.3 kB	Jan 22, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for django-kpi 1.0.0
File	Interpreter	ABI	Platform	Reset
django_kpi-1.0.0-py3-none-any.whl 12.2 kB Jan 22, 2025	Python 3	none	any	Details

Total release size: 23.5 kB

Release files / django_kpi-1.0.0.tar.gz

Download URL	django_kpi-1.0.0.tar.gz
Size	11.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`af08b0b3c562ebbd5b7b870ef8de9839b0666bbff4dbdcff013f0d2b1c535b94`
BLAKE2b-256 checksum How to use checksums	`d2bd4f44be980308d0fd8fbed1f3dd84bfe1fa23bebdad712f4503c5d6627d92`
Upload date	Jan 22, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.0.1 CPython/3.11.11`

Release files / django_kpi-1.0.0-py3-none-any.whl

Download URL	django_kpi-1.0.0-py3-none-any.whl
Size	12.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1b715a9cc4159a668d72398e88ff608bb0f215f16b240eb7814e06755b2a3e4f`
BLAKE2b-256 checksum How to use checksums	`11da9deb710fae6809e688a9ab42401e83916208cb0e7b1a147f911623429d4a`
Upload date	Jan 22, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.0.1 CPython/3.11.11`