| Name | prosperity2submit JSON |
| Version |
0.2.8
JSON |
| download |
| home_page | None |
| Summary | Command-line submitter for IMC Prosperity 2 algorithms |
| upload_time | 2024-04-18 18:27:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Jasper van Merle Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
imc
prosperity
submit
submitter
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# IMC Prosperity 2 Submitter
[](https://github.com/jmerle/imc-prosperity-2-submitter/actions/workflows/build.yml)
[](https://pypi.org/project/prosperity2submit/)
This repository contains a command-line submitter for [IMC Prosperity 2](https://prosperity.imc.com/) algorithms. It uploads the algorithm, monitors its progress, downloads the logs, logs the final profit / loss, and opens the submission in my [IMC Prosperity 2 Visualizer](https://github.com/jmerle/imc-prosperity-2-visualizer) (optional), all in one command.
## Usage
Basic usage:
```sh
# Install the latest version of the submitter
$ pip install -U prosperity2submit
# Submit an algorithm
$ prosperity2submit <path to algorithm file>
```
Run `pip install -U prosperity2submit` again when you want to update the submitter to the latest version.
Submitting requires your Prosperity ID token that is stored in the local storage item with the `CognitoIdentityServiceProvider.<some id>.<email>.idToken` key on the Prosperity website. You can inspect the local storage items of a website by having the website open in the active tab, pressing <kbd>F12</kbd> to open the browser's developer tools, and going to the _Application_ (Chrome) or _Storage_ (Firefox) tab. From there, click on _Local Storage_ in the sidebar and select the website that appears underneath the sidebar entry.
The submitter will prompt you for the token when it needs it. The token is then stored in your system's credentials store for convenience. ID tokens are short-lived, so you'll be prompted somewhat regularly and old tokens persisted in the credentials store do not pose much of a security risk.
By default, the submitter automatically downloads the submission's logs after simulation is done to `submissions/<timestamp>.log`. You can change this file using the `--out <path to log file>` option, or disable downloading logs altogether using the `--no-logs` flag.
If you use my [IMC Prosperity 2 Visualizer](https://github.com/jmerle/imc-prosperity-2-visualizer), the `--vis` flag will automatically open the submission in the visualizer after the simulation ends successfully.
## Development
If you want to make changes to the submitter, clone (or fork and clone) this repository and run `pip install -e .` in the project's root. This installs the project in editable mode, so any changes you make are automatically taken into account the next time you run `prosperity2submit`.
Raw data
{
"_id": null,
"home_page": null,
"name": "prosperity2submit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "imc, prosperity, submit, submitter",
"author": null,
"author_email": "Jasper van Merle <jaspervmerle@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fd/07/37ae8901b0970146b773be84fcf84c0dbbbf06e331d39df97bc7b12faada/prosperity2submit-0.2.8.tar.gz",
"platform": null,
"description": "# IMC Prosperity 2 Submitter\n\n[](https://github.com/jmerle/imc-prosperity-2-submitter/actions/workflows/build.yml)\n[](https://pypi.org/project/prosperity2submit/)\n\nThis repository contains a command-line submitter for [IMC Prosperity 2](https://prosperity.imc.com/) algorithms. It uploads the algorithm, monitors its progress, downloads the logs, logs the final profit / loss, and opens the submission in my [IMC Prosperity 2 Visualizer](https://github.com/jmerle/imc-prosperity-2-visualizer) (optional), all in one command.\n\n## Usage\n\nBasic usage:\n```sh\n# Install the latest version of the submitter\n$ pip install -U prosperity2submit\n\n# Submit an algorithm\n$ prosperity2submit <path to algorithm file>\n```\n\nRun `pip install -U prosperity2submit` again when you want to update the submitter to the latest version.\n\nSubmitting requires your Prosperity ID token that is stored in the local storage item with the `CognitoIdentityServiceProvider.<some id>.<email>.idToken` key on the Prosperity website. You can inspect the local storage items of a website by having the website open in the active tab, pressing <kbd>F12</kbd> to open the browser's developer tools, and going to the _Application_ (Chrome) or _Storage_ (Firefox) tab. From there, click on _Local Storage_ in the sidebar and select the website that appears underneath the sidebar entry.\n\nThe submitter will prompt you for the token when it needs it. The token is then stored in your system's credentials store for convenience. ID tokens are short-lived, so you'll be prompted somewhat regularly and old tokens persisted in the credentials store do not pose much of a security risk.\n\nBy default, the submitter automatically downloads the submission's logs after simulation is done to `submissions/<timestamp>.log`. You can change this file using the `--out <path to log file>` option, or disable downloading logs altogether using the `--no-logs` flag.\n\nIf you use my [IMC Prosperity 2 Visualizer](https://github.com/jmerle/imc-prosperity-2-visualizer), the `--vis` flag will automatically open the submission in the visualizer after the simulation ends successfully.\n\n## Development\n\nIf you want to make changes to the submitter, clone (or fork and clone) this repository and run `pip install -e .` in the project's root. This installs the project in editable mode, so any changes you make are automatically taken into account the next time you run `prosperity2submit`.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Jasper van Merle Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Command-line submitter for IMC Prosperity 2 algorithms",
"version": "0.2.8",
"project_urls": {
"Changelog": "https://github.com/jmerle/imc-prosperity-2-submitter/releases",
"Issues": "https://github.com/jmerle/imc-prosperity-2-submitter/issues",
"Repository": "https://github.com/jmerle/imc-prosperity-2-submitter"
},
"split_keywords": [
"imc",
" prosperity",
" submit",
" submitter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "159a42ba3a0e4576fc271706b90223b745835be0e98d42aa16946d50e8a997d5",
"md5": "a0ff5471cdf47dc1e7d22c07825241a3",
"sha256": "6ef839c61e4980ceac33f212d56136bc2d180dfaf0545af5211d183900ccb1f2"
},
"downloads": -1,
"filename": "prosperity2submit-0.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0ff5471cdf47dc1e7d22c07825241a3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 8089,
"upload_time": "2024-04-18T18:26:58",
"upload_time_iso_8601": "2024-04-18T18:26:58.756360Z",
"url": "https://files.pythonhosted.org/packages/15/9a/42ba3a0e4576fc271706b90223b745835be0e98d42aa16946d50e8a997d5/prosperity2submit-0.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fd0737ae8901b0970146b773be84fcf84c0dbbbf06e331d39df97bc7b12faada",
"md5": "e279c3269d6b7242b1a0185038ad6ea1",
"sha256": "94ef6a08c5f0ef563d7ebd0494f8e0ae161e81436132f2daec6f4611fec67275"
},
"downloads": -1,
"filename": "prosperity2submit-0.2.8.tar.gz",
"has_sig": false,
"md5_digest": "e279c3269d6b7242b1a0185038ad6ea1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6459,
"upload_time": "2024-04-18T18:27:00",
"upload_time_iso_8601": "2024-04-18T18:27:00.051190Z",
"url": "https://files.pythonhosted.org/packages/fd/07/37ae8901b0970146b773be84fcf84c0dbbbf06e331d39df97bc7b12faada/prosperity2submit-0.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 18:27:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jmerle",
"github_project": "imc-prosperity-2-submitter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "prosperity2submit"
}
