# AutoMSR
[](https://pypi.org/project/automsr/#history)
[](https://pypi.org/project/automsr)
[](https://github.com/Crissal1995/automsr/actions/workflows/checks.yaml)
## Description
**AutoMSR** is an automation tool created for educational purpose,
intending to show how to use Selenium as an automation driver
for the Microsoft Rewards service.
### What it does
This tool is intended to show how to collect automatically daily points for
Microsoft Rewards.
What is included:
- Daily promotions completed.
- Other activities completed.
- Free punchcards completed.
- Searches with a desktop User Agent completed.
- Searches with a mobile User Agent completed.
### Warning
Before using this software, read carefully the [Microsoft Terms of Service](https://www.microsoft.com/servicesagreement),
section _Microsoft Rewards_.
TL;DR: the usage of AutoMSR could lead in a ban.
## Setup
### Installation
```shell
$ pip install automsr # this will install the binary `automsr`
```
### Configuration
AutoMSR behaviour can be configured using a `config.yaml` file.
An example with every input described in detail is found here: [link](https://github.com/Crissal1995/automsr/blob/main/tests/configs/config.example.yaml).
### Chromedriver
Download the correct [Chromedriver](https://chromedriver.chromium.org/downloads) matching your Chrome version.
## Usage
### Help
```shell
$ automsr --help
```
### Execute AutoMSR
```shell
$ automsr run
# config.yaml is somewhere else than current directory
$ automsr run --config path/to/a/config.yaml
```
### Generate automatically a Config file
```shell
$ automsr init
```
### Retrieve local Chrome profiles
```shell
$ automsr profiles
# ChromeProfile(displayed_name='yourProfileName', path=Path('generic/profile/dir'))
$ automsr profiles --format pretty-json
# [
# {
# "displayed_name": "yourProfileName",
# "path": generic/profile/dir"
# }
# ]
```
### Check that email sending works
```shell
$ automsr email
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Crissal1995/automsr",
"name": "automsr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Cristiano Salerno",
"author_email": "cristianosalerno1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/13/ca/9d2bf041b849c3c68c422853a1890e4fe78acb8f63e53412fb9f4d0b4523/automsr-9.6.1.tar.gz",
"platform": null,
"description": "# AutoMSR\n\n[](https://pypi.org/project/automsr/#history)\n[](https://pypi.org/project/automsr)\n[](https://github.com/Crissal1995/automsr/actions/workflows/checks.yaml)\n\n## Description\n\n**AutoMSR** is an automation tool created for educational purpose,\nintending to show how to use Selenium as an automation driver\nfor the Microsoft Rewards service.\n\n### What it does\n\nThis tool is intended to show how to collect automatically daily points for\nMicrosoft Rewards.\n\nWhat is included:\n- Daily promotions completed.\n- Other activities completed.\n- Free punchcards completed.\n- Searches with a desktop User Agent completed.\n- Searches with a mobile User Agent completed.\n\n### Warning\n\nBefore using this software, read carefully the [Microsoft Terms of Service](https://www.microsoft.com/servicesagreement),\nsection _Microsoft Rewards_.\n\nTL;DR: the usage of AutoMSR could lead in a ban.\n\n## Setup\n\n### Installation\n\n```shell\n$ pip install automsr # this will install the binary `automsr`\n```\n\n### Configuration\n\nAutoMSR behaviour can be configured using a `config.yaml` file.\n\nAn example with every input described in detail is found here: [link](https://github.com/Crissal1995/automsr/blob/main/tests/configs/config.example.yaml).\n\n### Chromedriver\nDownload the correct [Chromedriver](https://chromedriver.chromium.org/downloads) matching your Chrome version.\n\n## Usage\n\n### Help\n\n```shell\n$ automsr --help\n```\n\n### Execute AutoMSR\n\n```shell\n$ automsr run\n\n# config.yaml is somewhere else than current directory\n$ automsr run --config path/to/a/config.yaml\n```\n\n### Generate automatically a Config file\n\n```shell\n$ automsr init\n```\n\n### Retrieve local Chrome profiles\n\n```shell\n$ automsr profiles\n# ChromeProfile(displayed_name='yourProfileName', path=Path('generic/profile/dir'))\n\n$ automsr profiles --format pretty-json\n# [\n# {\n# \"displayed_name\": \"yourProfileName\",\n# \"path\": generic/profile/dir\"\n# }\n# ]\n```\n\n### Check that email sending works\n\n```shell\n$ automsr email\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Automate Rewards points collection",
"version": "9.6.1",
"project_urls": {
"Homepage": "https://github.com/Crissal1995/automsr",
"Repository": "https://github.com/Crissal1995/automsr"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5fc29534594a8d6dce05a790a3a8fa6d59a2ac98043ee44df45995575efacb83",
"md5": "8dca5ad18b6ee2800dd2804086fc3d2b",
"sha256": "b93d7633f5326b41adeb7d06a119d04e88ac9a487acfe0c76247019973afe40f"
},
"downloads": -1,
"filename": "automsr-9.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8dca5ad18b6ee2800dd2804086fc3d2b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 32477,
"upload_time": "2023-09-23T21:34:03",
"upload_time_iso_8601": "2023-09-23T21:34:03.055860Z",
"url": "https://files.pythonhosted.org/packages/5f/c2/9534594a8d6dce05a790a3a8fa6d59a2ac98043ee44df45995575efacb83/automsr-9.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "13ca9d2bf041b849c3c68c422853a1890e4fe78acb8f63e53412fb9f4d0b4523",
"md5": "90f6e53d73e47e249a403bcf76815f8d",
"sha256": "e5c6d0d8803b66e8a9b54212913176cfe1165a4c3a623c5089cbb0c2cc80fdfb"
},
"downloads": -1,
"filename": "automsr-9.6.1.tar.gz",
"has_sig": false,
"md5_digest": "90f6e53d73e47e249a403bcf76815f8d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 28309,
"upload_time": "2023-09-23T21:34:04",
"upload_time_iso_8601": "2023-09-23T21:34:04.582309Z",
"url": "https://files.pythonhosted.org/packages/13/ca/9d2bf041b849c3c68c422853a1890e4fe78acb8f63e53412fb9f4d0b4523/automsr-9.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-23 21:34:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Crissal1995",
"github_project": "automsr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "automsr"
}
JSON
