elo-viz


Nameelo-viz JSON
Version 0.0.2 PyPI version JSON
download
home_pageNone
SummaryElo python package to simulate matches between players, and compare their elo ratings after each match, and visualize it.
upload_time2025-02-06 00:12:04
maintainerNone
docs_urlNone
authorAnurag Shenoy
requires_python<4.0,>=3.13
licenseMIT
keywords elo elo-score rating chess ranking score
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Overview
Elo python package to simulate matches between players, and compare their elo ratings after each match, and visualize them. You can use it to simulate rankings of Chess players.

# Installation

Install using pip:

```text
$ pip install elo-viz
```

or with [Poetry](https://python-poetry.org/):

```text
$ poetry add elo-viz
```

# Usage
### Create Players
```py
import uuid
from elo_viz import Match, Player

magnus_carlsen = Player(id=uuid.uuid4().hex, name='Magnus Carlsen', rating=2833)
hou_yifan = Player(id=uuid.uuid4().hex, name='Hou Yifan', rating=2633)
gukesh_d = Player(id=uuid.uuid4().hex, name='Gukesh Dommaraju', rating=2777)
divya_d = Player(id=uuid.uuid4().hex, name='Divya Deshmukh', rating=2490)
```

### Setup Matches
```py
m1 = Match(match_id=uuid.uuid4().hex, player1=magnus_carlsen, player2=gukesh_d)
m1.update_result(winner=magnus_carlsen.id)
```

### Check results
```py
print(m1.player1)
```
Output
```log
Player: Magnus Carlsen Rating: Rating: 2883.0 Win %: 100.0
```

# Requirements
- Python >= 3.13

The version of the base environment I had installed poetry in.

Will update this so that any Python 3 version will work.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "elo-viz",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.13",
    "maintainer_email": null,
    "keywords": "elo, elo-score, rating, chess, ranking, score",
    "author": "Anurag Shenoy",
    "author_email": "anuragshenoy21@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/48/ef/3c0855783b51ea34e7714d9a473d71fc51733f7bbae49250b43c36ef02fb/elo_viz-0.0.2.tar.gz",
    "platform": null,
    "description": "# Overview\nElo python package to simulate matches between players, and compare their elo ratings after each match, and visualize them. You can use it to simulate rankings of Chess players.\n\n# Installation\n\nInstall using pip:\n\n```text\n$ pip install elo-viz\n```\n\nor with [Poetry](https://python-poetry.org/):\n\n```text\n$ poetry add elo-viz\n```\n\n# Usage\n### Create Players\n```py\nimport uuid\nfrom elo_viz import Match, Player\n\nmagnus_carlsen = Player(id=uuid.uuid4().hex, name='Magnus Carlsen', rating=2833)\nhou_yifan = Player(id=uuid.uuid4().hex, name='Hou Yifan', rating=2633)\ngukesh_d = Player(id=uuid.uuid4().hex, name='Gukesh Dommaraju', rating=2777)\ndivya_d = Player(id=uuid.uuid4().hex, name='Divya Deshmukh', rating=2490)\n```\n\n### Setup Matches\n```py\nm1 = Match(match_id=uuid.uuid4().hex, player1=magnus_carlsen, player2=gukesh_d)\nm1.update_result(winner=magnus_carlsen.id)\n```\n\n### Check results\n```py\nprint(m1.player1)\n```\nOutput\n```log\nPlayer: Magnus Carlsen Rating: Rating: 2883.0 Win %: 100.0\n```\n\n# Requirements\n- Python >= 3.13\n\nThe version of the base environment I had installed poetry in.\n\nWill update this so that any Python 3 version will work.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Elo python package to simulate matches between players, and compare their elo ratings after each match, and visualize it.",
    "version": "0.0.2",
    "project_urls": {
        "Documentation": "https://github.com/shenoy-anurag/elo",
        "Funding": "https://buymeacoffee.com/anuragshenoy",
        "Homepage": "https://github.com/shenoy-anurag/elo",
        "Issues": "https://github.com/shenoy-anurag/elo/issues",
        "Repository": "https://github.com/shenoy-anurag/elo"
    },
    "split_keywords": [
        "elo",
        " elo-score",
        " rating",
        " chess",
        " ranking",
        " score"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6953881623de77031f2c74aac36370dd7ea90e271b67384483a7bf343cf0a6ca",
                "md5": "c5d12d42f9eb5dc63b5b83ffc021ab39",
                "sha256": "ee66806422ccab6eb687de98db11f86a6f86d539bb848fc9b5679280d57ceaaf"
            },
            "downloads": -1,
            "filename": "elo_viz-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c5d12d42f9eb5dc63b5b83ffc021ab39",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.13",
            "size": 8365,
            "upload_time": "2025-02-06T00:12:02",
            "upload_time_iso_8601": "2025-02-06T00:12:02.189572Z",
            "url": "https://files.pythonhosted.org/packages/69/53/881623de77031f2c74aac36370dd7ea90e271b67384483a7bf343cf0a6ca/elo_viz-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "48ef3c0855783b51ea34e7714d9a473d71fc51733f7bbae49250b43c36ef02fb",
                "md5": "132428d8ef7191344b6a4b75d7b74e7e",
                "sha256": "935abd8288ffedfa59162ed55fed1e20731a1e6b3b04fc37d100e50d2906ea2d"
            },
            "downloads": -1,
            "filename": "elo_viz-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "132428d8ef7191344b6a4b75d7b74e7e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.13",
            "size": 6595,
            "upload_time": "2025-02-06T00:12:04",
            "upload_time_iso_8601": "2025-02-06T00:12:04.257665Z",
            "url": "https://files.pythonhosted.org/packages/48/ef/3c0855783b51ea34e7714d9a473d71fc51733f7bbae49250b43c36ef02fb/elo_viz-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-06 00:12:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "shenoy-anurag",
    "github_project": "elo",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "elo-viz"
}
        
Elapsed time: 0.41570s