# This is a proof of concept of the Belenios election protocol.
## Installation
```
$ cd poc
$ pip install -r requirements.txt
$ python setup.py install
```
## Development
This project includes a number of helpers in the `Makefile` to streamline common development tasks.
### Environment Setup
The following demonstrates setting up and working with a development environment:
### Create a virtualenv for development
```
$ cd poc
$ make virtualenv
$ source env/bin/activate
```
### Run belenios cli application
```
$ belenios --help
```
### Run an election automaticaly
```
$ cd poc
$ python3 tests/auto_election.py
```
### Run an election automaticaly (with Pedersen)
```
$ cd poc
$ python3 tests/auto_election_pedersen.py
```
### Run pytest / coverage
```
$ cd poc
$ make test
```
### Releasing to PyPi
Before releasing to PyPi, you must configure your login credentials:
**~/.pypirc**:
```
[pypi]
username = YOUR_USERNAME
password = YOUR_PASSWORD
```
Then use the included helper function via the `Makefile`:
```
$ cd poc
$ make dist
$ make dist-upload
```
## Deployments
### Docker
Included is a basic `Dockerfile` for building and distributing `Belenios`,
and can be built with the included `make` helper:
```
$ cd poc
$ make docker
$ docker run -it belenios --help
```
Raw data
{
"_id": null,
"home_page": "https://etulab.univ-amu.fr/b21211803/projet-ter-2024-belenios",
"name": "belenios",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "BISCHOFF Taylor, BRIONGOS Alexandre, ILLA Mohamed abdallahi, MALIGUE Dylan",
"author_email": "alexandre.briongos@etu.univ-amu.fr",
"download_url": "https://files.pythonhosted.org/packages/3b/7a/51aafdba7d9df055817a2a436e281228ca9bfe491930cc2558fdc090d448/belenios-0.0.4.tar.gz",
"platform": null,
"description": "# This is a proof of concept of the Belenios election protocol.\n\n## Installation\n\n```\n$ cd poc\n$ pip install -r requirements.txt\n$ python setup.py install\n```\n\n## Development\n\nThis project includes a number of helpers in the `Makefile` to streamline common development tasks.\n\n### Environment Setup\n\nThe following demonstrates setting up and working with a development environment:\n\n\n### Create a virtualenv for development\n\n```\n$ cd poc\n$ make virtualenv\n$ source env/bin/activate\n```\n\n### Run belenios cli application\n```\n$ belenios --help\n```\n\n### Run an election automaticaly\n```\n$ cd poc\n$ python3 tests/auto_election.py\n```\n\n### Run an election automaticaly (with Pedersen)\n```\n$ cd poc\n$ python3 tests/auto_election_pedersen.py\n```\n\n### Run pytest / coverage\n```\n$ cd poc\n$ make test\n```\n\n\n### Releasing to PyPi\n\nBefore releasing to PyPi, you must configure your login credentials:\n\n**~/.pypirc**:\n\n```\n[pypi]\nusername = YOUR_USERNAME\npassword = YOUR_PASSWORD\n```\n\nThen use the included helper function via the `Makefile`:\n\n```\n$ cd poc\n$ make dist\n$ make dist-upload\n```\n\n## Deployments\n\n### Docker\n\nIncluded is a basic `Dockerfile` for building and distributing `Belenios`,\nand can be built with the included `make` helper:\n\n```\n$ cd poc\n$ make docker\n$ docker run -it belenios --help\n```\n",
"bugtrack_url": null,
"license": "unlicensed",
"summary": "This is a proof of concept of the Belenios election protocol.",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://etulab.univ-amu.fr/b21211803/projet-ter-2024-belenios"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26f8bc0e69454e8af363eaa505d348e4407f5977865185a863335790b0e836bb",
"md5": "3210c69aa82fcb8d3813b364bdfddb9b",
"sha256": "ad89bfbfb730b3bf7c2757afe99677e8d6bf6159b809abec42a35e09f8cf232e"
},
"downloads": -1,
"filename": "belenios-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3210c69aa82fcb8d3813b364bdfddb9b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 74988,
"upload_time": "2024-03-28T14:34:36",
"upload_time_iso_8601": "2024-03-28T14:34:36.719336Z",
"url": "https://files.pythonhosted.org/packages/26/f8/bc0e69454e8af363eaa505d348e4407f5977865185a863335790b0e836bb/belenios-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3b7a51aafdba7d9df055817a2a436e281228ca9bfe491930cc2558fdc090d448",
"md5": "cdcfbba0b0788c2a286c072437641e31",
"sha256": "a365b407d059f0378f80f62df56bc93d8d4e818b63e779225d66e32a8e5a9e99"
},
"downloads": -1,
"filename": "belenios-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "cdcfbba0b0788c2a286c072437641e31",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 41391,
"upload_time": "2024-03-28T14:34:38",
"upload_time_iso_8601": "2024-03-28T14:34:38.053754Z",
"url": "https://files.pythonhosted.org/packages/3b/7a/51aafdba7d9df055817a2a436e281228ca9bfe491930cc2558fdc090d448/belenios-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-28 14:34:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "belenios"
}
JSON