# GuedesMoney
## Description
GuedesMoney is a CLI tool meant to interact and interface with Portal das Finanças automatically via NIF/Password credentials. GuedesMoney is meant to be used for automation and allows for easy access to any action or information in Portal das Finanças through web scraping.
## Installation
```
pip install guedesmoney
```
or
```
pip install guedesmoney==<any_version> (for instance 1.0.1)
```
## Usage
Like any other CLI tool guedesmoney keeps it simple by asking for a command action and arguments in this order
```
guedesmoney <command> <args> <option>
```
## Documentation
| Command | Arguments | Description |
| -------- | -------- | -------- |
|check-alerts|headless, save_results, screenshot|Will check the current alerts|
|check-fiscal|headless, save_results, screenshot|Will check the state of the current fiscal situation|
|check-interactions|headless, save_results, screenshot|Will check the current interactions|
|check-messages|headless, save_results, screenshot|Will check the current messages|
|check-payments|headless, save_results, screenshot, current, missing, refund|Will check state of the current payments|
|config|check_config, show_password|Will prompt user to setup the CLI configuration|
|login|headless|Will check if login credentials are correct|
|run|headless, save_results, screenshot,check-fiscal,check-alerts, check-messages, check-interactions, check-payments ,current, missing, refund, send-email, attach-screenshots|Can run all commands in GuedesMoney (recommended for pipeline integration)|
|version|*none*|Returns the current version of guedesmoney|
| Argument |small | Type | Description |
| -------- | -------- | -------- | -------- |
|headless|hl|boolean|Run scraper in headless mode|
|save_results|sr|boolean|Save results to file|
|screenshot|ss|boolean|Save a screenshot of the of window|
|check-fiscal|cf|boolean|Run Check Fiscal Command|
|check-alerts|ca|boolean|Run Check Alerts Command|
|check-messages|cm|boolean|Run Check Messages Command|
|check-interactions|ci|boolean|Run Check Interactions Command|
|check-payments|cp|boolean|Run Check Payments Command|
|current|c|boolean|Check the state of the current payments|
|missing|m|boolean|Check the state of the missing payments|
|refund|r|boolean|Check the state of the refund payments|
|send-email|e|boolean|Sends an email with the results of the run|
|attach-screenshots|as|boolean|Attach the screenshots to the email|
|check_config|c|boolean|Checks CLI configuration instead of configuring it|
|show_password|shp|boolean|Show password in CLI configuration check|
|user_nif|un|text|User NIF|
|user_password|up|text|User Password|
|email_type|et|text|Sender email provider|
|sender_email|se|text|Sender email|
|sender_password|sp|text|Sender email password|
|recipient_list|rl|text|Recipient list (comma-separated)|
## Example
The following example will run every command and verify every check in guedesmoney through the command run:
```
guedesmoney run --headless --save_results --screenshot --check-fiscal --check-alerts --check-messages --check-interactions --check-payments --current --missing --refund
```
## Tools
- Typer
- Selenium
- bumpversion
## Contributing
You must clone the repo
```
git clone https://github.com/JoaoGuedes01/scraper_portal_financas.git
```
Create a new feature branch (keep it simple and to the point as to follow gitflow)
```
git checkout <your_new_branch>
```
Then you need to merge onto dev branch, which will need CODEOWNER's approval and then your change can be featured in the next version of guedesmoney.
## License
```
MIT License
```
Raw data
{
"_id": null,
"home_page": "https://github.com/JoaoGuedes01/scraper_portal_financas",
"name": "guedesmoney",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Portal_Das_Finan\u00e7as CLI Python Typer Selenium Automation",
"author": "Jo\u00e3o Guedes",
"author_email": "joaoguedes.cjp@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f5/b0/fd20ddcb49440df9d9957e3d23bf3c00170f1d4fe8b4c255cad5e5598334/guedesmoney-1.2.0.tar.gz",
"platform": null,
"description": "# GuedesMoney\n\n## Description\n\nGuedesMoney is a CLI tool meant to interact and interface with Portal das Finan\u00e7as automatically via NIF/Password credentials. GuedesMoney is meant to be used for automation and allows for easy access to any action or information in Portal das Finan\u00e7as through web scraping.\n\n## Installation\n```\npip install guedesmoney\n```\nor\n```\npip install guedesmoney==<any_version> (for instance 1.0.1)\n```\n## Usage\nLike any other CLI tool guedesmoney keeps it simple by asking for a command action and arguments in this order\n```\nguedesmoney <command> <args> <option>\n```\n## Documentation\n| Command | Arguments | Description |\n| -------- | -------- | -------- |\n|check-alerts|headless, save_results, screenshot|Will check the current alerts|\n|check-fiscal|headless, save_results, screenshot|Will check the state of the current fiscal situation|\n|check-interactions|headless, save_results, screenshot|Will check the current interactions|\n|check-messages|headless, save_results, screenshot|Will check the current messages|\n|check-payments|headless, save_results, screenshot, current, missing, refund|Will check state of the current payments|\n|config|check_config, show_password|Will prompt user to setup the CLI configuration|\n|login|headless|Will check if login credentials are correct|\n|run|headless, save_results, screenshot,check-fiscal,check-alerts, check-messages, check-interactions, check-payments ,current, missing, refund, send-email, attach-screenshots|Can run all commands in GuedesMoney (recommended for pipeline integration)|\n|version|*none*|Returns the current version of guedesmoney|\n\n| Argument |small | Type | Description |\n| -------- | -------- | -------- | -------- |\n|headless|hl|boolean|Run scraper in headless mode|\n|save_results|sr|boolean|Save results to file|\n|screenshot|ss|boolean|Save a screenshot of the of window|\n|check-fiscal|cf|boolean|Run Check Fiscal Command|\n|check-alerts|ca|boolean|Run Check Alerts Command|\n|check-messages|cm|boolean|Run Check Messages Command|\n|check-interactions|ci|boolean|Run Check Interactions Command|\n|check-payments|cp|boolean|Run Check Payments Command|\n|current|c|boolean|Check the state of the current payments|\n|missing|m|boolean|Check the state of the missing payments|\n|refund|r|boolean|Check the state of the refund payments|\n|send-email|e|boolean|Sends an email with the results of the run|\n|attach-screenshots|as|boolean|Attach the screenshots to the email|\n|check_config|c|boolean|Checks CLI configuration instead of configuring it|\n|show_password|shp|boolean|Show password in CLI configuration check|\n|user_nif|un|text|User NIF|\n|user_password|up|text|User Password|\n|email_type|et|text|Sender email provider|\n|sender_email|se|text|Sender email|\n|sender_password|sp|text|Sender email password|\n|recipient_list|rl|text|Recipient list (comma-separated)|\n\n## Example\nThe following example will run every command and verify every check in guedesmoney through the command run:\n```\nguedesmoney run --headless --save_results --screenshot --check-fiscal --check-alerts --check-messages --check-interactions --check-payments --current --missing --refund\n```\n\n## Tools\n- Typer\n- Selenium\n- bumpversion\n\n## Contributing\nYou must clone the repo\n```\ngit clone https://github.com/JoaoGuedes01/scraper_portal_financas.git\n```\nCreate a new feature branch (keep it simple and to the point as to follow gitflow)\n```\ngit checkout <your_new_branch>\n```\nThen you need to merge onto dev branch, which will need CODEOWNER's approval and then your change can be featured in the next version of guedesmoney.\n## License\n```\nMIT License\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "A CLI interface for interacting with Portal das Finan\u00e7as automatically and programmatically",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/JoaoGuedes01/scraper_portal_financas"
},
"split_keywords": [
"portal_das_finan\u00e7as",
"cli",
"python",
"typer",
"selenium",
"automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f76cf1c6c479da95ad6916732c16b4d3a3c9f62b0dcfdd52432f7982394c887",
"md5": "f447ca31fdf62237341600490d78461b",
"sha256": "c4e55d45824d0b27673b9172f2219fd4725d1493ad91e6af8ce666055dfe6e76"
},
"downloads": -1,
"filename": "guedesmoney-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f447ca31fdf62237341600490d78461b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10867,
"upload_time": "2024-02-21T16:46:20",
"upload_time_iso_8601": "2024-02-21T16:46:20.316771Z",
"url": "https://files.pythonhosted.org/packages/4f/76/cf1c6c479da95ad6916732c16b4d3a3c9f62b0dcfdd52432f7982394c887/guedesmoney-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f5b0fd20ddcb49440df9d9957e3d23bf3c00170f1d4fe8b4c255cad5e5598334",
"md5": "da7babec840fabd141220df5afe29106",
"sha256": "73f68e6df1007946c5a218c9728b005cbd470174c01e9c2aab56653203bc4e6d"
},
"downloads": -1,
"filename": "guedesmoney-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "da7babec840fabd141220df5afe29106",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9678,
"upload_time": "2024-02-21T16:46:24",
"upload_time_iso_8601": "2024-02-21T16:46:24.976329Z",
"url": "https://files.pythonhosted.org/packages/f5/b0/fd20ddcb49440df9d9957e3d23bf3c00170f1d4fe8b4c255cad5e5598334/guedesmoney-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-21 16:46:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JoaoGuedes01",
"github_project": "scraper_portal_financas",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "guedesmoney"
}
JSON
