| Name | paybybot3 JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | https://github.com/rklf/paybybot3 |
| Summary | CLI interface to https://www.paybyphone.fr/ |
| upload_time | 2024-11-04 09:32:29 |
| maintainer | None |
| docs_url | None |
| author | rklf |
| requires_python | >=3.6 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PayByBot 3
Originally forked from [paybybot2](https://github.com/louisabraham/paybybot2/), this packages implements a CLI interface to [paybyphone](https://www.paybyphone.fr/), allowing you (for example) to automate parking.
## Installation
pip install paybybot3
## Usage
`CONFIG_NAME` is the name of your configuration, it would be `example_account` in the example configuration below.
`--location` is often the district (eg `75001`). There are some special values that you can find out in the output of `check` as `locationId`.
Similarly, you can find `--rate` as `rateOptionId` in the output of `check`.
### alert
```
Usage: paybybot3 alert [OPTIONS] CONFIG_NAME
1. Check if there is an ongoing subscription
2. Else send a notification
Options:
--location TEXT
--config TEXT
--help Show this message and exit.
```
### check
```
Usage: paybybot3 check [OPTIONS] CONFIG_NAME
Check if there is an ongoing subscription
Options:
--location TEXT
--config TEXT
--help Show this message and exit.
```
### pay
```
Usage: paybybot3 pay [OPTIONS] CONFIG_NAME
1. Check if there is an ongoing subscription
2. Else pay
3. Check that the payment succeeded
4. Notify on failure
Options:
--location TEXT [required]
--rate INTEGER [required]
--duration TEXT [required]
--unit [Days|Hours|Minutes] Default: Days
--buffer
--config TEXT
--help Show this message and exit.
```
### vehicles
```
Usage: paybybot3 vehicles [OPTIONS] CONFIG_NAME
1. Show the vehicles
Options:
--config TEXT
--help Show this message and exit.
```
### payment-accounts
```
Usage: paybybot3 payment-accounts [OPTIONS] CONFIG_NAME
Show the payment accounts
Options:
--config TEXT
--help Show this message and exit.
```
## Configuration
paybybot3 allows you to store your configuration in a YAML file `~/.config/paybybot3.yml`.
Here is an example:
```
example_account:
plate: AB123CD
paybyphone:
login: "+330612345678"
password: password
apprise: #optional
services:
- mail:
service_url: "mailtos://{user}:{password}@{domain}?name=PayByBot3"
tag:
- "broadcast-warning"
- "broadcast-failure"
- discord:
service_url: "discord://{WebhookID}/{WebhookToken}"
tag:
- "broadcast-info"
- "broadcast-success"
- "broadcast-warning"
- "broadcast-failure"
- ...
paymentAccountId: "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
```
Notifications are delivered through the [Apprise](https://github.com/caronc/apprise) library.
If `apprise` is configured, at least one service must be configured. Service URLs can be found in the Apprise [notification services documentation](https://github.com/caronc/apprise/wiki#notification-services) - refer to their documentation for required and additional parameters. Tags are mandatory and must at least be one of `broadcast-info`, `broadcast-success`, `broadcast-warning` or `broadcast-failure`, they are used to filter the notifications you want to receive.
The `paymentAccountId` can be found in the output of the `payment-accounts` command.
Raw data
{
"_id": null,
"home_page": "https://github.com/rklf/paybybot3",
"name": "paybybot3",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "rklf",
"author_email": "contact@rklf.fr",
"download_url": "https://files.pythonhosted.org/packages/50/0a/9a2c842699e076fe93f46269b0dec320e977eff128fd1b30c4bcd7f2ddde/paybybot3-0.1.5.tar.gz",
"platform": null,
"description": "# PayByBot 3\n\nOriginally forked from [paybybot2](https://github.com/louisabraham/paybybot2/), this packages implements a CLI interface to [paybyphone](https://www.paybyphone.fr/), allowing you (for example) to automate parking.\n\n## Installation\n\n pip install paybybot3\n\n## Usage\n\n`CONFIG_NAME` is the name of your configuration, it would be `example_account` in the example configuration below.\n\n`--location` is often the district (eg `75001`). There are some special values that you can find out in the output of `check` as `locationId`.\n\nSimilarly, you can find `--rate` as `rateOptionId` in the output of `check`.\n\n### alert\n\n```\nUsage: paybybot3 alert [OPTIONS] CONFIG_NAME\n\n 1. Check if there is an ongoing subscription\n\n 2. Else send a notification\n\nOptions:\n --location TEXT\n --config TEXT\n --help Show this message and exit.\n```\n\n### check\n\n```\nUsage: paybybot3 check [OPTIONS] CONFIG_NAME\n\n Check if there is an ongoing subscription\n\nOptions:\n --location TEXT\n --config TEXT\n --help Show this message and exit.\n```\n\n### pay\n\n```\nUsage: paybybot3 pay [OPTIONS] CONFIG_NAME\n\n 1. Check if there is an ongoing subscription\n\n 2. Else pay\n\n 3. Check that the payment succeeded\n\n 4. Notify on failure\n\nOptions:\n --location TEXT [required]\n --rate INTEGER [required]\n --duration TEXT [required]\n --unit [Days|Hours|Minutes] Default: Days\n --buffer\n --config TEXT\n --help Show this message and exit.\n```\n\n### vehicles\n\n```\nUsage: paybybot3 vehicles [OPTIONS] CONFIG_NAME\n\n 1. Show the vehicles\n\nOptions:\n --config TEXT\n --help Show this message and exit.\n```\n\n### payment-accounts\n\n```\nUsage: paybybot3 payment-accounts [OPTIONS] CONFIG_NAME\n\n Show the payment accounts\n\nOptions:\n --config TEXT\n --help Show this message and exit.\n```\n\n## Configuration\n\npaybybot3 allows you to store your configuration in a YAML file `~/.config/paybybot3.yml`.\n\nHere is an example:\n\n```\nexample_account:\n plate: AB123CD\n paybyphone:\n login: \"+330612345678\"\n password: password\n apprise: #optional\n services:\n - mail:\n service_url: \"mailtos://{user}:{password}@{domain}?name=PayByBot3\"\n tag:\n - \"broadcast-warning\"\n - \"broadcast-failure\"\n - discord:\n service_url: \"discord://{WebhookID}/{WebhookToken}\"\n tag:\n - \"broadcast-info\"\n - \"broadcast-success\"\n - \"broadcast-warning\"\n - \"broadcast-failure\"\n - ...\n paymentAccountId: \"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\"\n```\n\nNotifications are delivered through the [Apprise](https://github.com/caronc/apprise) library. \nIf `apprise` is configured, at least one service must be configured. Service URLs can be found in the Apprise [notification services documentation](https://github.com/caronc/apprise/wiki#notification-services) - refer to their documentation for required and additional parameters. Tags are mandatory and must at least be one of `broadcast-info`, `broadcast-success`, `broadcast-warning` or `broadcast-failure`, they are used to filter the notifications you want to receive.\n\nThe `paymentAccountId` can be found in the output of the `payment-accounts` command.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI interface to https://www.paybyphone.fr/",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/rklf/paybybot3"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe78ea9171249c736659b97c09562f78cb621ca1af336174ec370e5b0fc85311",
"md5": "de327e019936457ad7876ad0822d12d7",
"sha256": "c86bf1ea372b60a43293dd8d14a462c943e72c2bebb09db1e35b035945938ff0"
},
"downloads": -1,
"filename": "paybybot3-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "de327e019936457ad7876ad0822d12d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8689,
"upload_time": "2024-11-04T09:32:27",
"upload_time_iso_8601": "2024-11-04T09:32:27.829038Z",
"url": "https://files.pythonhosted.org/packages/fe/78/ea9171249c736659b97c09562f78cb621ca1af336174ec370e5b0fc85311/paybybot3-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "500a9a2c842699e076fe93f46269b0dec320e977eff128fd1b30c4bcd7f2ddde",
"md5": "9f15235ff5a80f12fcd0c6852e3f1a8e",
"sha256": "f409857d2f090e66af549498dee8367b2e0cbad3aba42d890aeddddc663987ce"
},
"downloads": -1,
"filename": "paybybot3-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "9f15235ff5a80f12fcd0c6852e3f1a8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8611,
"upload_time": "2024-11-04T09:32:29",
"upload_time_iso_8601": "2024-11-04T09:32:29.491016Z",
"url": "https://files.pythonhosted.org/packages/50/0a/9a2c842699e076fe93f46269b0dec320e977eff128fd1b30c4bcd7f2ddde/paybybot3-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 09:32:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rklf",
"github_project": "paybybot3",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "paybybot3"
}
