Election-Tech-Initiative / Election-Tech-Initiative/electionguard

🚀 Autogenerate Sample Data from Sample Manifests

Open
#217 4 comments 0 reactions 0 assignees View on GitHub
documentation enhancement good first issue help wanted
Dominant language
Python
Stars
872
Forks
131
PR merge metrics
No merged PRs in 30d

Description

### Is there an existing issue for this?

- [X] I have searched the existing issues

### Suggestion

There are a couple problems with Sample Data that we would like to address.
1. The sample data being out of date from the SDK
2. Storing all the manifest sample data files within this repository

### Possible Implementation

The large collection of sample data should be removed in favor of using the code to generate samples.

- [ ] Retain only the sample manifests in the repository
- [ ] Delete other folders all the sample data
- [ ] Create a `generate_sample` workflow for specifically handling the sample data updates allowing for the Specification to be released WITHOUT the sample data since the code has to update for it to be generated.
- [ ] Import the `electionguard` package from python to generate the sample data on the release workflow
- [ ] Ensure the release data is zipped and possibly tarballed (#216 ) and attached to releases
- [ ] Update the Sample Data document. It should mention the same things but refer to the releases and the sample manifests instead of the individual files.

### Anything else?

This is currently blocked until `electionguard-python` 1.4 is released.

This issue replaces #215 to include more detail.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.