Skip to content

Commit

Permalink
Update readme linting issues
Browse files Browse the repository at this point in the history
  • Loading branch information
@JohnMwashuma
JohnMwashuma committed Nov 4, 2024
1 parent 703c9e0 commit e640ffb
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 23 deletions.
18 changes: 12 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Tally-Ho

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: [None]; Actual: # Tally-Ho Warning

Expected: [None]; Actual: # Tally-Ho

![Build Status](https://github.com/onaio/tally-ho/actions/workflows/config.yml/badge.svg?branch=master)
[![codecov](https://codecov.io/github/onaio/tally-ho/branch/master/graph/badge.svg?token=1PR3KIqgr6)](https://codecov.io/github/onaio/tally-ho)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/1e817ebba18946fa84cb129cdc914f0b)](https://app.codacy.com/gh/onaio/tally-ho/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

## Tally-Ho!
## Overview

Election results data entry and verification software built by [Ona Systems](http://company.ona.io) and commissioned by the Libyan [High National Elections Commission](http://hnec.ly/) and the [United Nations Development Program](http://www.undp.org).

Expand All @@ -23,28 +25,33 @@ mkvirtualenv tally --python=python3.9
pip install -r requirements/dev.pip
```

Install `libpq-dev` library that contains a minimal set of `PostgreSQL`_ binaries and headers requried
Install `libpq-dev` library that contains a minimal set of `PostgreSQL`_binaries and headers requried

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 102 Warning

Expected: 80; Actual: 102
for building 3rd-party applications for `PostgreSQL`_.

```bash
sudo apt-get install libpq-dev
```

Install memcache

```bash
sudo apt-get update && sudo apt-get install -y memcached
```

Install redis

```bash
sudo apt-get install -y redis-server
```

Make sure you have the latest versions of pip, wheel, and setuptools installed, run

```bash
python -m pip install -U pip wheel setuptools
```

To Enable [pre-commit hook checks](https://pre-commit.com/#3-install-the-git-hook-scripts) for development, in your virtual env, run

```bash
pre-commit install
```
Expand All @@ -54,6 +61,7 @@ pre-commit install
```bash
celery -A tally_ho.celeryapp worker --loglevel=info
```

### Quick start with user demo data

> This will remove all data in the database.
Expand All @@ -77,7 +85,6 @@ python manage.py runserver --settings=tally_ho.settings.dev
### Advanced: recreate the database, then load the data and demo users

> This will remove all data in the database.
> This will only work if you have data files in the folder `./data`
The first argument is the database user, the second is the database host IP
Expand Down Expand Up @@ -161,20 +168,19 @@ django-admin compilemessages

This command will compile all `.po` files, including Arabic, into `.mo` files for use by Django.

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 96 Warning

Expected: 80; Actual: 96


### Generating Model Graphs

The below assumes you have `pip` installed `requirements/dev.pip` and [graphviz](https://graphviz.org/download/) in your machine.

Generate model graph for all models:

```
```python
python manage.py graph_models --settings=tally_ho.settings.dev --pydot -a -g -o tally-ho-all-models.png
```

Generate model graph for app models:

```
```python
python manage.py graph_models --settings=tally_ho.settings.dev --pydot -a -X GroupObjectPermission,UserObjectPermission,GroupObjectPermissionBase,BaseGenericObjectPermission,UserObjectPermissionBase,BaseObjectPermission,Version,Revision,Pageview,Visitor,Session,AbstractBaseSession,Site,LogEntry,User,Group,AbstractUser,Permission,ContentType,AbstractBaseUser,PermissionsMixin,BaseModel -g -o tally-ho-app-models.png
```

Expand Down
33 changes: 16 additions & 17 deletions docs/overview/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## System Overview
# System Overview

**tally-system** is used to record, verify, and report the results of paper votes
that have been used in an election. Tally centers enter *result forms* and
Expand Down Expand Up @@ -83,7 +83,7 @@ form is not a replacement form it will have a pre-assigned center and station.
If it is a replacement form the clerk will next enter the center and station
number for that form.

![](images/intake.png)
![Intake](images/intake.png)

The original form or the replacement form is a duplicate if there is already a
form in the system with the same ballot, center, and station. If the form is a
Expand Down Expand Up @@ -115,17 +115,17 @@ The Data Entry Clerk begins by entering the barcode for a form they have
received. The system then shows the results component, which displays the
candidates that appear on the ballot assigned
to the form in the order in which they appear on the ballot (and form). The physical form
shows the number of results for each candidate. The Data Entry Clerk must enter the
shows the number of results for each candidate. The Data Entry Clerk must enter the
results for each candidate that appear on the form into the system.

![](images/data-entry-results.png)
![Data entry results](images/data-entry-results.png)

If the form contains a reconcilliation component, the Clerk must also enter
reconciliation information regarding the number of ballots, number of stampted
votes, number of damaged votes, etc. The system will use this information
later when deciding whether to Audit the form.

![](images/data-entry.png)
![data entry](images/data-entry.png)

After a Data Entry 1 Clerk has entered the form's information, the system moves the
form to Data Entry 2 and the Clerk is instructed to move the physical form to
Expand All @@ -141,9 +141,9 @@ and 2 matches exactly the Clerk is simply displayed a message and the form is
moved to quality control. The Corrections Clerk begins by entering a barcode
for the form they have received.

![](images/corrections.png)
![corrections](images/corrections.png)

If any entries do not match, the system displays the information entered
If any entries do not match, the system displays the information entered
during Data Entry 1 and 2 side-by-side. The Corrections Clerk must select the
correct information and select "Submit Corrections", "Not Correct - Reject", or
"Abort". If the Clerk chooses "Submit" the corrections are stored and the form
Expand All @@ -154,7 +154,7 @@ in the pipeline from there. If the Clerk choose "Abort" no corrections are
saved, the forms stays in corrections, and the Clerk is returned to the enter
barcode entry screen.

![](images/corrections-results.png)
![corrections results](images/corrections-results.png)

### Quality Control

Expand All @@ -169,7 +169,7 @@ form is move to Data Entry 1 and continues in the pipeline from there. If the
Clerk chooses "Abort" the form stays in quality control, and the Clerk is
returned to the enter barcode screen.

![](images/quality-control.png)
![quality control](images/quality-control.png)

### Archiving

Expand All @@ -187,7 +187,7 @@ Otherwise, the Archiving Clerk prints an *Archived* cover sheet and attaches it
to the form. The Clerk selects "Print Successful", moving the form to archived
state. The form is then filed away.

![](images/archive.png)
![archive](images/archive.png)

## Review Stages

Expand Down Expand Up @@ -223,7 +223,7 @@ recommendations made by a clerk for the form the choose
the system moves form to Unsubmitted state, and the physical form is returned to
the Intake Section.

![](images/clearance.png)
![clearance](images/clearance.png)

### Audit

Expand Down Expand Up @@ -260,7 +260,7 @@ recommending that the form skip Quarantine Checks on its next time through the
system. The form is then hidden from the Audit team and must then be reviewed
by a Super Administration before moving to Data Entry 1.

![](images/audit-review.png)
![audit review](images/audit-review.png)

## Super Administrator Views

Expand All @@ -277,7 +277,7 @@ change. The *Forms Waiting For Approval* list shows those forms which a Super
Administrator must review. Rows in this list link to the Audit review view for
the forms.

![](images/admin-review.png)
![admin review](images/admin-review.png)

### Reports Views

Expand All @@ -286,15 +286,15 @@ current state within the system. This view is useful to determine where a form
is in processing and to see how many forms from a particular center have been
entered into the system.

![](images/reports-progress.png)
![reports progress](images/reports-progress.png)

The *Reports Offices* list shows the percentage of forms in each state within
the system. This can be used to balance the Clerk assigned to specific
stations. For example, if there are twice as many forms in Data Entry 1 than
in Data Entry 2, it may be wise to assign some Clerk from Data Entry 2 to Dat
Entry 1.

![](images/reports-race.png)
![reports race](images/reports-race.png)

This view also shows the number of Intaken and Archived form for each Office
(analogous to a type of voting district). This allows administrators to track
Expand All @@ -319,12 +319,11 @@ that can be entered into the system.
The *Forms Not Received List* shows the barcodes for forms that the system has
not yet intaken.


### Results Exports

The *Downloads* section allows Super Administrators to export both simple and
deteailed results views. The *All Candidate Votes* download shows a simple
spreadsheet of the leading candidates and their votes accross all ballots. The
spreadsheet of the leading candidates and their votes accross all ballots. The
same for *Active Candidate Votes* which only shows votes for active candidates.
The *Result Form List* returns a detailed file of the results entered for every
result form and associated information about that result form, e.g. gender,
Expand Down

0 comments on commit e640ffb

Please sign in to comment.