{"id":13414928,"url":"https://github.com/OmegaTrading/OmegaUI","last_synced_at":"2025-03-14T22:32:28.482Z","repository":{"id":217374714,"uuid":"132277372","full_name":"OmegaTrading/OmegaUI","owner":"OmegaTrading","description":"Backtrader Front End","archived":false,"fork":false,"pushed_at":"2018-07-09T18:49:17.000Z","size":561,"stargazers_count":167,"open_issues_count":3,"forks_count":59,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-07-31T21:53:18.928Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OmegaTrading.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-05T19:14:36.000Z","updated_at":"2024-07-26T13:10:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"bf6f919d-bb4e-46d4-8176-f382fb4484e5","html_url":"https://github.com/OmegaTrading/OmegaUI","commit_stats":null,"previous_names":["omegatrading/omegaui"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmegaTrading%2FOmegaUI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmegaTrading%2FOmegaUI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmegaTrading%2FOmegaUI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmegaTrading%2FOmegaUI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OmegaTrading","download_url":"https://codeload.github.com/OmegaTrading/OmegaUI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243658057,"owners_count":20326459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T21:00:39.974Z","updated_at":"2025-03-14T22:32:28.154Z","avatar_url":"https://github.com/OmegaTrading.png","language":"Python","readme":"# Omega UI\n\nBacktesting Front End for backtrader (see: https://www.backtrader.com/). Built with Plotly/Dash.\n\n**Important:**\n  * Before using, please make sure to update the file **omega-ui.config** at the root of the omega_ui folder.\nThis file contains configuration parameters that are used throughout the application.\n  * A Redis instance must be running (this is used to display logs) and the package folder needs to be in PythonPath.\n\n**What needs to be updated:**\n  * Default/Module: This is the module where the class implementing the Backtest class is (make sure that the module is in\nPythonPath).\n  * Default/Class: Name of the class implementing the Backtest class.\n  * Default/Redis: IP address of the Redis datastore (Default port: 6379).\n  * Logging/Root: Path to where logs will be stored.\n  * Backtest/Cash: Default cash value.\n  * Backtest/Modules: Modules where the strategies are located (several modules can be implemented using commas as\na delimiter).\n\n\n## 1. Installation:\nFrom source: Place the omega_ui directory found in the sources inside your project\n\n## 2. Usage:\n  * Before the UI can be used, the Backtest class needs to be implemented. This is done by inheriting the class Backtest\nfrom omega_ui.backtest and implementing the following methods:\n  * get_symbols: Symbols that will be displayed on the UI and on which we can run a backtest.\n  * get_parameters: Default parameters for a given strategy.\n  * run: Run a backtest. Please note that this needs to return 2 items: returns and results from backtrader.\n\n  * Before running the UI, the following command has to be running: 'python socket_logging.py flask run'. This is the\nserver which redirects the logs to the UI.\n\n  * To run the UI, run the following command: 'python app.py' and in your browser (tested only on Chrome), navigate to\nthe specified address (should be http://127.0.0.1:8050/).\n\n## 3. Example:\nAn example has been included in the tests folder to give an idea on how to use the UI (see test_backtest.py). When\nusing it, please make sure to select the strategy \"TestStrategy\" in the Strategy dropwdown as selecting ExampleBacktest\nwould not work.\n\n## Note:\nThis project is designed for people already comfortable using and writing python code. I do not have time to provide\nsupport but am happy to help if you get in touch regarding the following topics:\n  * Error messages\n  * Documentation\n  * Suggestions for extra features\n  * Bugs\nI will try to reply to messages but can't guarantee it (as long as the message is properly formatted). This is a work\nin progress and also a project which I use for my research. Offers to contribute will be accepted.\n\nAlso, if nothing happens while trying to run a backtest, this might be due to a problem with the Dash React part.\nI had an issue where I had to roll back Dash to a specific version and haven't tried to use the latest version again.\nTo find out if there's a problem with React, right-click in Chrome and select Inspect, then navigate to the Console\ntab and look for errors. See below to know which dash packages work with this application:\n* dash==0.21.0\n* dash-auth==0.1.0\n* dash-core-components==0.20.2\n* dash-html-components==0.10.0\n* dash-renderer==0.11.3\n* dash-table-experiments==0.6.0\n","funding_links":[],"categories":["Trading Automatico"],"sub_categories":["Trading Automatico - Self-Hosted Software"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOmegaTrading%2FOmegaUI","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOmegaTrading%2FOmegaUI","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOmegaTrading%2FOmegaUI/lists"}