Skip to content

Commit

Permalink
Updated app to reflect new website UI
Browse files Browse the repository at this point in the history
  • Loading branch information
AshishJii committed Jun 3, 2024
1 parent 13c214c commit 864b871
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 29 deletions.
38 changes: 38 additions & 0 deletions ErpSnap.spec
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# -*- mode: python ; coding: utf-8 -*-


a = Analysis(
['main.py'],
pathex=[],
binaries=[],
datas=[('assets', 'assets/')],
hiddenimports=[],
hookspath=[],
hooksconfig={},
runtime_hooks=[],
excludes=[],
noarchive=False,
)
pyz = PYZ(a.pure)

exe = EXE(
pyz,
a.scripts,
a.binaries,
a.datas,
[],
name='ErpSnap',
debug=False,
bootloader_ignore_signals=False,
strip=False,
upx=True,
upx_exclude=[],
runtime_tmpdir=None,
console=False,
disable_windowed_traceback=False,
argv_emulation=False,
target_arch=None,
codesign_identity=None,
entitlements_file=None,
icon=['assets\\logo.ico'],
)
61 changes: 34 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,40 @@
# ErpSnap2
# ErpSnap

ErpSnap2 is a widget application that provides a one-click interface to view the latest information from the PSIT ERP. It saves time by directly fetching data from APIs, allowing users to quickly access the information they need.
A widget application that provides a one-click interface to view the latest info from PSIT ERP. It saves time by directly fetching data from APIs, allowing users to quickly access the information they need.

## Installation FAQ

<details open>
<summary>How to install ErpSnap?</summary>

1. Download the [latest release](https://github.com/ashishjii/ErpSnap/releases/latest) and install it.
3. After installation, find ErpSnap in the Start menu or use the desktop shortcut.
4. On initial launch, click the refresh button in the top-right corner to input credentials.
</details>

<details>
<summary>I'm seeing a Windows Defender SmartScreen warning. What should I do?</summary>
If you encounter a Windows Defender SmartScreen warning, click on "More info" and then click "Run anyway". This warning appears because the program is not digitally signed with an **Extended Validation (EV) code signing certificate**, which costs around $300-$800. Rest assured, ErpSnap is not a virus.
</details>

<details>
<summary>How do I exit the app?</summary>
To exit the application, click on the info button located at the top right corner of the screen, then click "Exit application".
</details>

<details>
<summary>I entered my username and details incorrectly. What should I do?</summary>
If you've entered your username and/or details incorrectly, you can reset them by deleting the credentials file located at `%AppData%/ErpSnap`. To do this, open your file manager and copy-paste the provided location into the address bar. After deleting the file, restart the application, and you will be prompted to enter your credentials again.
</details>

## Features

| Feature | Status |
|-|-|
| Draggable widget | ✔️ |
| Does not appears in taskbar | ✔️ |
| Does not appear in taskbar | ✔️ |
| Installation file created | ✔️ |
| Aut0ostarts on Windows boot | ✔️ |
| Autostarts on Windows boot | ✔️ |
| Prompt for roll/pass on initial run | ✔️ |
| Move request call to dedicated worker thread | ✔️ |
| Provide progress indicators for logging and data retrieval | ✔️ |
Expand All @@ -24,31 +49,13 @@ ErpSnap2 is a widget application that provides a one-click interface to view the
| Add option to re-enter info | |

>[!NOTE]
>Consider using `urllib3` instead of `requests` library to reduce third party dependency requirements.
## Installation FAQ

#### How do I install ErpSnap2?

1. Download the Latest Release: Visit the [latest release](https://github.com/ashishjii/ErpSnap/releases/latest) page on GitHub and download the ErpSnap setup file.
2. Run the Setup: Double-click the downloaded file (ErpSnapSetup.exe) to start installation.
3. Once the installation is complete, you can launch ErpSnap from the Start menu or desktop shortcut.
4. On initial launch, click the refresh button in the top-right corner to enter credentials.

#### I'm seeing a Windows Defender SmartScreen warning. What should I do?

If you encounter a Windows Defender SmartScreen warning, click on "More info" and then click "Run anyway". This warning appears because the program is not digitally signed with an **Extended Validation (EV) code signing certificate**, which costs around $300-$800. Rest assured, ErpSnap is not a virus.

#### How do I exit the app?

To exit the application, click on the info button located at the top right corner of the screen, then click "Exit application".

#### I entered my username and details incorrectly. What should I do?

If you've entered your username and/or details incorrectly, you can reset them by deleting the credentials file located at `%AppData%/ErpSnap`. To do this, open your file manager and copy-paste the provided location into the address bar. After deleting the file, restart the application, and you will be prompted to enter your credentials again.
>Consider using `urllib3` instead of `requests` library to reduce third-party dependency requirements.
## Contributing

<details>
<summary>Contribution Guidelines</summary>

1. Clone the repository:
```bash
git clone https://github.com/AshishJii/ErpSnap.git
Expand All @@ -71,8 +78,8 @@ pyinstaller --noconfirm --onefile --windowed --icon "assets/logo.ico" --name "Er
- Fork the repository.
- Make your changes in a feature branch.
- Submit a pull request with your changes.
</details>

## License

This project is licensed under the Apache-2.0 License - see the [LICENSE](LICENSE) file for details.

2 changes: 1 addition & 1 deletion backend.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ def fetch_information(self):

data = attendance_res['data'].text
total_lecture = extract_info(data, "Total Lecture : ([0-9]*)")
total_absent = extract_info(data, "Total Absent : ([0-9]*)")
total_absent = extract_info(data, "Total Absent \+ OAA: ([0-9]*)")
attendance_percentage = extract_info(data, "Attendance Percentage : ([0-9.]*)\s%")
# self.thread.progress.emit(['AttenTab',f'{total_lecture}\n{total_absent}\n{attendance_percentage}'])
# TODO: Move this to frontend
Expand Down
2 changes: 1 addition & 1 deletion gui.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ def show_info_dialog(self):
dialog.setText(
"<div style='text-align:center;margin: 0 auto'>"
"<b>App Name:</b> ErpSnap<br>"
"<b>Version:</b> 2.4<br>"
"<b>Version:</b> 2.4.1<br>"
"<b>Developer: <a href='https://www.github.com/AshishJii'>Ashish Verma</a><br>"
"</div>"
)
Expand Down

0 comments on commit 864b871

Please sign in to comment.