Merge pull request #108 from TrustTheVote-Project/development

Update version number & documentation

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Change Log
+
+A version history of BallotLab.
+
+## 0.1.2 - September 7, 2022
+
+Complete Milestone 1: flat file PDF. Notable features include:
+
+* Multi-candidate tickets (including contest section IDs)
+* Write-ins (also with contest selection IDs)
+* Ballot measure questions
+* Additional layout enhancements, especially to reduce page count
+
+## 0.1.1 - June 29, 2022
+
+Create make ballots interface w/ 100% pytest coverage. Begin version tracking.
+
+## 0.1 - October 25th, 2021
+
+Code first published under the OSET License.

README.md

@@ -2,6 +2,8 @@
 
 Encapsulated Python software for generating EAC-compliant ballots from NIST 1500-100 election definition datasets, part of the OSET BallotStudio project.
 
+For a version history, please see CHANGELOG.md
+
 ## Getting Started
 
 This Python project uses Poetry for dependency management. To get started:
@@ -14,19 +16,27 @@ This Python project uses Poetry for dependency management. To get started:
 
 For detailed instructions on how to work with the code in this repo, check out [Getting Started with BallotLab · TrustTheVote-Project/BallotLab Wiki](https://github.com/TrustTheVote-Project/BallotLab/wiki/Getting-Started-with-BallotLab).
 
-Once you've set up the virtual environment with `poetry shell` you can run the Python app using poetry run`:
+Once you've set up the virtual environment with `poetry shell` you can run the Python app without having to use `poetry run` -- like this:
 
 ```python
-poetry run ballotmaker --help        # display the CLI help text
-poetry run ballotmaker --version     # display the current version number
+ballotmaker --help        # display the CLI help text
+ballotmaker --version     # display the current version number
 ```
 
+Check the help pages for details on other sub-commands you can use with ballotmaker.
+
 ## Running Tests
 
 After you've followed the steps above in **Getting Started**, you can also run the `pytest` suite with this command:
 
 ```python
-poetry run pytest
+pytest
+```
+
+Or, if you'd like to review coverage information and logging updates, try this command:
+
+``` python
+pytest --cov-report term-missing --cov=src/ --log-format="%(asctime)s %(levelname)s %(message)s" --log-cli-level=info
 ```
 
 ## The Wiki

src/electos/ballotmaker/constants.py

@@ -4,7 +4,7 @@
 import errno
 
 PROGRAM_NAME = "BallotMaker"
-VERSION = "0.1.1"
+VERSION = "0.1.2"  # incremented September 7, 2022
 
 NO_ERRORS = 0
 NO_FILE = errno.ENOENT