votekit 0.0.0__tar.gz

votekit-0.0.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.1
+Name: votekit
+Version: 0.0.0
+Summary: A Swiss Army Knife for computational social choice research
+Author: MGGG
+Author-email: engineering@mggg.org
+Requires-Python: >=3.9,<3.12
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
+Requires-Dist: matplotlib (>=3.7.2,<4.0.0)
+Requires-Dist: mypy (>=1.4.1,<2.0.0)
+Requires-Dist: networkx (>=3.1,<4.0)
+Requires-Dist: pandas (>=2.0.2,<3.0.0)
+Requires-Dist: pandas-stubs (>=2.0.2.230605,<3.0.0.0)
+Requires-Dist: pydantic (>=1.10.9,<2.0.0)
+Requires-Dist: scipy (>=1.11.1,<2.0.0)
+Description-Content-Type: text/markdown
+
+## Development
+
+This project requires [`poetry`](https://python-poetry.org/docs/#installation), and Python >= 3.9. (This version chosen somewhat arbitrarily.)
+
+To get up and running, run `poetry install` from within the project directory to install all dependencies. This will create a `.venv` directory that will contain dependencies. You can interact with this virtualenv by running your commands prefixed with `poetry run`, or use `poetry shell` to activate the virtualenv.
+
+Once you've run `poetry install`, if you run `poetry run pre-commit install` it will install code linting hooks that will run on every commit. This helps ensure code quality.
+
+To run tests run `poetry run pytest` or `./run_tests.sh` (the latter will generate a coverage report).
+
+To release, run `poetry publish --build`
+

votekit-0.0.0/README.md

@@ -0,0 +1,11 @@
+## Development
+
+This project requires [`poetry`](https://python-poetry.org/docs/#installation), and Python >= 3.9. (This version chosen somewhat arbitrarily.)
+
+To get up and running, run `poetry install` from within the project directory to install all dependencies. This will create a `.venv` directory that will contain dependencies. You can interact with this virtualenv by running your commands prefixed with `poetry run`, or use `poetry shell` to activate the virtualenv.
+
+Once you've run `poetry install`, if you run `poetry run pre-commit install` it will install code linting hooks that will run on every commit. This helps ensure code quality.
+
+To run tests run `poetry run pytest` or `./run_tests.sh` (the latter will generate a coverage report).
+
+To release, run `poetry publish --build`

votekit-0.0.0/pyproject.toml

@@ -0,0 +1,32 @@
+[tool.poetry]
+name = "votekit"
+version = "0.0.0"
+description = "A Swiss Army Knife for computational social choice research"
+authors = ["MGGG <engineering@mggg.org>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.9,<3.12"
+scipy = "^1.11.1"
+pandas = "^2.0.2"
+mypy = "^1.4.1"
+pydantic = "^1.10.9"
+pandas-stubs = "^2.0.2.230605"
+networkx = "^3.1"
+jinja2 = "^3.1.2"
+matplotlib = "^3.7.2"
+
+
+[tool.poetry.group.dev.dependencies]
+ruff = "^0.0.275"
+black = "^23.3.0"
+pytest = "^7.4.0"
+pytest-cov = "^4.1.0"
+pre-commit = "^3.3.3"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+line-length = 100

votekit-0.0.0/src/votekit/ballot.py

@@ -0,0 +1,45 @@
+from pydantic import BaseModel
+from typing import Optional
+from fractions import Fraction
+
+
+class Ballot(BaseModel):
+    """
+    id (optional string): assigned ballot id
+    ranking (list): list of candidate ranking
+    weight (float/fraction): weight assigned to a given a ballot
+    voters (optional list): list of voters who cast a given a ballot
+    """
+
+    id: Optional[str] = None
+    ranking: list[set]
+    weight: Fraction
+    voters: Optional[set[str]] = None
+
+    class Config:
+        arbitrary_types_allowed = True
+
+    def __eq__(self, other):
+        # Check type
+        if not isinstance(other, Ballot):
+            return False
+
+        # Check id
+        if self.id is not None:
+            if self.id != other.id:
+                return False
+
+        # Check ranking
+        if self.ranking != other.ranking:
+            return False
+
+        # Check weight
+        if self.weight != other.weight:
+            return False
+
+        # Check voters
+        if self.voters is not None:
+            if self.voters != other.voters:
+                return False
+
+        return True