Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2.1.1 #44

Merged
merged 2 commits into from
Oct 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,23 @@ It is important to note that this project locally handles the user credentials o
### Video Tutorial
[Automated Connecticut Weekly Unemployment Benefits](https://www.youtube.com/watch?v=Ff6FEwIE0Bw)

### Install ([PyPI](https://pypi.org/project/reemployct-data-entry/))
### Install
```
pip install reemployct-data-entry
```

### Magic quick start command!
```
jobentry
```
Run this command every time you want to run the program. If this doesn't work, continue with the manual steps below.


### Setup (Python)
<details>
<summary><h2>Manual startup</h2></summary>
You first need to get your copy of the Excel file that the program knows how to read job application data from:

```
python
from reemployct_data_entry import entry
```
This will import the module you'll use to run the program, but also provide you with the path to the provided Excel template. Make a copy of `workSearch_template.xlsx`, save it wherever (and rename it whatever) you want. Open your copy, remove the row that contains the example job application, and start adding your own data (in the same format as the example row).
Expand All @@ -46,10 +53,16 @@ You can either run from the CLI with:
entry.main()
```
Or simply click `entry.py` to run it.
</details>

## User Credentials
<details>
<summary><h2>User Credentials</h2></summary>
To make the entire process streamlined, you can save your ReEmployCT login credentials when prompted by the CLI. Your credentials are encrypted and stored locally in the project folder in `credFile.ini` (only the username is left as plaintext). The encryption key is stored in `key.key`. You also have the option when saving your credentials to set an expiry time so that you will need to save a new set of credentials on a certain date.

### Resetting saved credentials
1. Delete `credFile.ini` from the project folder
2. You will be prompted for new credentials when you run `entry.main()`
</details>

### Links
[PyPI](https://pypi.org/project/reemployct-data-entry/)
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "reemployct-data-entry"
version = "2.1.0"
version = "2.1.1"
description = "Automated entry of job application data into Connecticut's DOL ReEmployCT portal."
authors = ["Ariff Jeff <[email protected]>"]
readme = "README.md"
Expand Down
2 changes: 1 addition & 1 deletion reemployct_data_entry/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
PACKAGE_NAME = 'reemployct_data_entry'

# can't use stdlib importlib.metadata here because remote tests will fail due to needing the package build
__version__ = "2.1.0"
__version__ = "2.1.1"

# on `import reemployct_data_entry`, print the excel job data template file path for user convenience
if __name__ == PACKAGE_NAME:
Expand Down
Loading