Djangelo
Django Plugin for tracking and rating actions with ELO system.
Implementation Example
- You have a blog.
- Your blog have posts.
- Each post have comments, likes and other user reactions.
- You want to evaluate which posts have lower or beyond user reactions in a quantitative way
This is your solution!
Main Features:
- Track activity of your Django Models
- Compare the activity of each Object with the activity of all objects tracked
- Determine an ELO rating from this comparation
Cool Features:
- Easy to implement
- Ready to use
Documentation
Getting Started
Dependencies
- python >= 3.5
- Django >= 3
Installation
pip install djangelo
And then, three simple steps
FIRST: Add djangelo into your INSTALLED_APPS and define which models you want to track
INSTALLED_APPS = [
# ...
'django.contrib.contenttypes',
'djangelo'
]
DJANGELO = {
'RATED_MODELS': [
'myapp1.mymodel1',
'myapp1.mymodel2',
'myapp2.mymodel1',
]
}
SECOND: Get elo values from your Model
# Adding the ELORated on your models, those will be tracked
from django.db import models
from djangelo.utils import EloDescriptor
class MyModel(models.Model):
elo = EloDescriptor()
# ... here your code
# You can also get and compare elo rated objects
instance1.elo.value
>> 3.5
instance1.elo >= instance2.elo
>> True
FINALLY: Define when your objects increments his rating.
# To increse the elo rating just call elo.up() method
myModelInstance.elo.up()
myModelInstance.elo.down()
Customization
DJANGELO = {
# Increse the sensibility for more sensitive rating.
# This make more impact for each tracked activity
# by default is 32
'SENSIBILITY': 64,
# You can define a default ELO value for the new objects created
# by default is 1200
'INITIAL_VALUE': 4000
'RATED_MODELS': [...]
}
Contributing
Contributors are wellcome! Any new feature will be well recibed as merge request or issue.
Licence
Licensed over APACHE 2.0. See LICENSE
Manteiner
This software is developed and mantained by Agustin Jimenez.
Metadata
Release files for djangelo 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| djangelo-0.1.4-py3-none-any.whl | Python 3 | none | any | Details for djangelo-0.1.4-py3-none-any.whl |
Release files / djangelo-0.1.4-py3-none-any.whl
| Download URL | djangelo-0.1.4-py3-none-any.whl |
|---|---|
| Size | 14.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5a1addd64777c4a33f640444e5a543840517a3a2ccf452115d0f9b5790cf882a
|
|
BLAKE2b-256 checksum How to use checksums |
a5f92cfcea7b1e4b24a20e9bb79e91029a00b0e4e0fa1259b83fdae09921d974
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5
|
Security for djangelo 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.