Skip to content

Commit

Permalink
Removed print statements, added view columns to receipts. Updated eve…
Browse files Browse the repository at this point in the history
…rything for release
  • Loading branch information
kevinpthorne committed Dec 15, 2020
1 parent fbead26 commit 198fbe3
Show file tree
Hide file tree
Showing 23 changed files with 719 additions and 154 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,24 @@ However, EmpDat can be run on any operating system Python is supported on.
### The easy way

##### Windows:
1. ~~Run the installer wizard in win/EmpDatSetup.exe~~
- Due to security issues with Windows, an installation wizard is not possible.
1. Unzip the `Portable.exe.zip` to a location of choice.
1. Unzip the `Portable.win.zip` to a location of choice.
2. Run `EmpDat.exe`
3. Done!

#### The hard way: from source
#### The harder way: from included environment
Most of the steps require a terminal window.
1. Acquire the source from either the deployment ZIP archive
- `src/` is the source folder within the deployment ZIP archive
1. Acquire the source with dependencies from the deployment ZIP archive
- `src_w_deps.zip`
2. Ensure Python 3 (version 3.6 minimum) is installed.
3. Activate the virtual environment by running:
- `.\venv\Scripts\activate.bat`
4. Install dependencies: `pip install -r requirements.txt`
5. Run `python EmpDat.py`

#### The hard way: from scratch
Most of the steps require a terminal window.
1. Acquire the source from the deployment ZIP archive
- `src.zip`
2. Ensure Python 3 (version 3.6 minimum) is installed.
3. Install dependencies: `pip3 install -r requirements.txt`
4. Run `python3 EmpDat.py`
Expand All @@ -42,9 +50,10 @@ Most of the steps require a terminal window.
- Password: `Ineed2changemypassword!`
2. On the top bar, click **File > Change Password**
and change the super-admin's password to preference
3. Import previous database of employees
3. If desired, import previous database of employees
- On the top bar, click **Import > Employees** and locate the previous CSV database
- *Note: the database can be converted back into a CSV using the Employee Directory Report*
4. Consult the User Manual for performing other operations

## Development

Expand Down
27 changes: 18 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# EmpDat
Is this hard to read? [View this on GitHub!](https://uvu-cs2450-001-fall2020-team2.github.io/EmpDat/)

Employee Database Application for CS 2450-001 Fall 2020.
- Kevin Thorne
Expand All @@ -20,16 +21,24 @@ However, EmpDat can be run on any operating system Python is supported on.
### The easy way

##### Windows:
1. ~~Run the installer wizard in win/EmpDatSetup.exe~~
- Due to security issues with Windows, an installation wizard is not possible.
1. Unzip the `Portable.exe.zip` to a location of choice.
1. Unzip the `Portable.win.zip` to a location of choice.
2. Run `EmpDat.exe`
3. Done!

#### The hard way: from source
#### The harder way: from included environment
Most of the steps require a terminal window.
1. Acquire the source from either the deployment ZIP archive
- `src/` is the source folder within the deployment ZIP archive
1. Acquire the source with dependencies from the deployment ZIP archive
- `src_w_deps.zip`
2. Ensure Python 3 (version 3.6 minimum) is installed.
3. Activate the virtual environment by running:
- `.\venv\Scripts\activate.bat`
4. Install dependencies: `pip install -r requirements.txt`
5. Run `python EmpDat.py`

#### The hard way: from scratch
Most of the steps require a terminal window.
1. Acquire the source from the deployment ZIP archive
- `src.zip`
2. Ensure Python 3 (version 3.6 minimum) is installed.
3. Install dependencies: `pip3 install -r requirements.txt`
4. Run `python3 EmpDat.py`
Expand All @@ -41,9 +50,10 @@ Most of the steps require a terminal window.
- Password: `Ineed2changemypassword!`
2. On the top bar, click **File > Change Password**
and change the super-admin's password to preference
3. Import previous database of employees
3. If desired, import previous database of employees
- On the top bar, click **Import > Employees** and locate the previous CSV database
- *Note: the database can be converted back into a CSV using the Employee Directory Report*
4. Consult the User Manual for performing other operations

## Development

Expand All @@ -62,9 +72,8 @@ Any time anything needs to be ran or installed
within the application, activate the virtual environment using
Step 3 above. Deactivation can be done with the command `deactivate`.


### Documentation
##### [ui/](ui/index.html) - Front end
##### [tests/](tests/index.html) - Tests
##### [lib/](lib/index.html) - Back end
##### [EmpDat.py](EmpDat.html) - Main
##### [EmpDat.py](EmpDat.html) - Main
2 changes: 1 addition & 1 deletion docs/lib/cli/import_csv.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ <h1 class="title">Module <code>lib.cli.import_csv</code></h1>

from lib.model.employee import Employee
from lib.model.receipt import Receipt
from lib.model.time_sheet import TimeSheet
from lib.model.timesheet import TimeSheet


def _import_csv(filepath: str, has_headers=False):
Expand Down
Loading

0 comments on commit 198fbe3

Please sign in to comment.