Valgret is an open-source project that implements the Schulze method of voting complete with a user interface and database. It was created for organizations of any size to provide tools for internal decision-making, public polling and transparency.
This module was written with FastAPI using an asynchronous postgresql database. The complementary front end code can be found in this repository.
Valgret uses poetry for dependency management.
Clone the repository and run:
poetry installto install required dependencies. Afterwards, create an .env file containing:
SQLALCHEMY_DATABASE_URI = "postgresql+asyncpg://user:password@postgresserver/db"
Modify the connection string for your own database server.
For a postgresql docker image that was created with these settings:
docker run -d --name postgres -e POSTGRES_PASSWORD=admin -v ${HOME}/Desktop/postgres-data/:/var/lib/postgresql/data -p 5432:5432 postgresthe .env file will be
SQLALCHEMY_DATABASE_URI = "postgresql+asyncpg://postgres:admin@localhost/postgres"
Valgret uses alembic to manage migrations.
alembic revision
alembic upgrade headYou can run the app with:
uvicorn votingapp.main:app --reloadAfterwards you can check localhost:8000/docs for interactive API docs and more info.
For a full list of features and how to access them please refer to the documentation.
Activate the virtual environment if you're not in it
poetry shelland make sure a database server is running. To run the tests:
pytestPull requests are welcome.