/
init.py
207 lines (158 loc) · 8.84 KB
/
init.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
# Lean CLI v1.0. Copyright 2021 QuantConnect Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from pathlib import Path
from typing import Optional, Tuple
from click import command, option, Choice, confirm, prompt
from lean.click import LeanCommand
from lean.constants import DEFAULT_DATA_DIRECTORY_NAME, DEFAULT_LEAN_CONFIG_FILE_NAME
from lean.container import container
from lean.models.errors import MoreInfoError
from lean.models.logger import Option
from lean.components.config.storage import safe_save
def _get_organization_id(user_input: str) -> Tuple[str, str]:
"""Get the id of a given organization if the user_input is an organization name.
Raises an error if no organization with a matching name or id can be found.
If the user_input is an id (and it exists), it will be returned.
:param user_input: the input given by the user
:return the organization id and name
"""
from re import match
api_client = container.api_client
if match("^[a-f0-9]{32}$", user_input) is not None:
# user input cloud be an id
try:
# We look up the organization to make sure the user is a member of it
organization = api_client.organizations.get(user_input)
return organization.id, organization.name
except:
pass
organizations = api_client.organizations.get_all()
organization = next((o for o in organizations if o.id == user_input or o.name == user_input), None)
if organization is None:
raise RuntimeError(f"You are not a member of an organization with name or id '{user_input}'")
return organization.id, organization.name
def _select_organization() -> Tuple[str, str]:
"""Asks the user for the organization that should be used.
:return: the selected organization id
"""
api_client = container.api_client
organizations = api_client.organizations.get_all()
options = [Option(id=organization.id, label=organization.name) for organization in organizations]
logger = container.logger
organization_id = logger.prompt_list("Select the organization to use for this Lean CLI instance", options)
return organization_id, next(iter(o.name for o in organizations if o.id == organization_id))
def _download_repository(output_path: Path) -> None:
"""Downloads the LEAN repository as a zip file.
:param output_path: the path to the zip file where the LEAN repository must be saved to
"""
logger = container.logger
logger.info("Downloading latest sample data from the Lean repository...")
# We download the entire Lean repository and extract the data and the launcher's config file
# GitHub doesn't allow downloading a specific directory
# Since we need ~80% of the total repository in terms of file size this shouldn't be too big of a problem
response = container.http_client.get("https://github.com/QuantConnect/Lean/archive/master.zip", stream=True)
total_size_bytes = int(response.headers.get("content-length", 0))
print_file_size_at_mb = 10
# Sometimes content length isn't set, don't show a progress bar in that case
if total_size_bytes > 0:
progress = logger.progress()
progress_task = progress.add_task("")
else:
progress = progress_task = None
try:
with output_path.open("wb") as file:
written_bytes = 0
for chunk in response.iter_content(chunk_size=8192):
file.write(chunk)
written_bytes += len(chunk)
if progress is not None:
progress.update(progress_task, completed=(written_bytes / total_size_bytes) * 100)
file_size_mb = round(written_bytes / 1024 / 1024, 2)
if file_size_mb >= print_file_size_at_mb:
print_file_size_at_mb += 20
logger.info(f"Download Progress {file_size_mb} MB")
except KeyboardInterrupt as e:
if progress is not None:
progress.stop()
raise e
if progress is not None:
progress.stop()
@command(cls=LeanCommand)
@option("--organization", type=str, help="The name or id of the organization the Lean CLI will be scaffolded for")
@option("--language", "-l",
type=Choice(container.cli_config_manager.default_language.allowed_values, case_sensitive=False),
help="The default language to use for new projects")
def init(organization: Optional[str], language: Optional[str]) -> None:
"""Scaffold a Lean configuration file and data directory."""
from shutil import copytree
from zipfile import ZipFile
# Select and set organization
if organization is not None:
organization_id, organization_name = _get_organization_id(organization)
else:
organization_id, organization_name = _select_organization()
logger = container.logger
logger.info(f'Using selected organization "{organization_name}"')
# Set default language
current_dir = Path.cwd()
data_dir = current_dir / DEFAULT_DATA_DIRECTORY_NAME
lean_config_path = current_dir / DEFAULT_LEAN_CONFIG_FILE_NAME
# Abort if one of the files we are going to create already exists to prevent us from overriding existing files
for path in [data_dir, lean_config_path]:
if path.exists():
relative_path = path.relative_to(current_dir)
raise MoreInfoError(f"{relative_path} already exists, please run this command in an empty directory",
"https://www.lean.io/docs/v2/lean-cli/initialization/directory-structure#02-lean-init")
# Warn the user if the current directory is not empty
if next(current_dir.iterdir(), None) is not None:
logger.info("This command will create a Lean configuration file and data directory in the current directory")
confirm("The current directory is not empty, continue?", default=False, abort=True)
# Download the Lean repository
tmp_directory = container.temp_manager.create_temporary_directory()
_download_repository(tmp_directory / "master.zip")
# Extract the downloaded repository
with ZipFile(tmp_directory / "master.zip") as zip_file:
zip_file.extractall(tmp_directory / "master")
# Copy the data directory
copytree(tmp_directory / "master" / "Lean-master" / "Data", data_dir)
# Create the config file
lean_config_manager = container.lean_config_manager
config = (tmp_directory / "master" / "Lean-master" / "Launcher" / "config.json").read_text(encoding="utf-8")
config = lean_config_manager.clean_lean_config(config)
lean_config_manager.store_known_lean_config_path(lean_config_path)
# Update the data-folder configuration
config = config.replace('"data-folder": "../../../Data/"', f'"data-folder": "{DEFAULT_DATA_DIRECTORY_NAME}"')
safe_save(path=lean_config_path, data=config)
# Add the organization id to the lean config
organization_manager = container.organization_manager
organization_manager.configure_working_organization_id(organization_id)
# Prompt for some general configuration if not set yet
cli_config_manager = container.cli_config_manager
if cli_config_manager.default_language.get_value() is None:
default_language = language if language is not None else prompt(
"What should the default language for new projects be?",
default=cli_config_manager.default_language.default_value,
type=Choice(cli_config_manager.default_language.allowed_values))
cli_config_manager.default_language.set_value(default_language)
logger.info(f"""
The following objects have been created:
- {DEFAULT_LEAN_CONFIG_FILE_NAME} contains the configuration used when running the LEAN engine locally
- {DEFAULT_DATA_DIRECTORY_NAME}/ contains the data that is used when running the LEAN engine locally
The following documentation pages may be useful:
- Setting up local autocomplete: https://www.lean.io/docs/v2/lean-cli/projects/autocomplete
- Synchronizing projects with the cloud: https://www.lean.io/docs/v2/lean-cli/projects/cloud-synchronization
Here are some commands to get you going:
- Run `lean create-project "My Project"` to create a new project with starter code
- Run `lean cloud pull` to download all your QuantConnect projects to your local drive
- Run `lean backtest "My Project"` to backtest a project locally with the data in {DEFAULT_DATA_DIRECTORY_NAME}/
""".strip())