Projects

Structure

Introduction

When running the lean create-project or lean cloud pull commands, the CLI creates the basic files and folders most editors need to open your source code, provide autocomplete, and enable local debugging. This page documents exactly which files are created when a project directory is created by lean create-project or lean cloud pull.

Python Project Structure

After creating a new Python project directory with lean create-project -l python <projectName> or by pulling a Python project with lean cloud pull, the following structure is created:

.
├── .idea/
│   ├── misc.xml
│   ├── modules.xml
│   ├── <projectName>.iml
│   └── workspace.xml
├── .vscode/
│   ├── launch.json
│   └── settings.json
├── config.json
├── main.py (only generated by lean create-project)
└── research.ipynb (only generated by lean create-project)

These files contain the following content:

FileContent
.idea/misc.xml,
.idea/modules.xml,
.idea/<projectName>.iml
These files contain PyCharm configuration so PyCharm can provide accurate autocomplete.
.idea/workspace.xmlThis file contains debug configuration to make debugging with PyCharm easier.
.vscode/launch.jsonThis file contains debug configuration to make debugging with VS Code easier.
.vscode/settings.jsonThis file contains VS Code configuration so that VS Code's Python and Pylance extensions can provide accurate autocomplete.
config.jsonThis file contains the project configuration of the created project.
main.pyThis file contains a basic Python algorithm to help you get started.
research.ipynbThis file contains a Python-based research notebook that can be opened in a research environment.

C# Project Structure

After creating a new C# project directory with lean create-project -l csharp <projectName> or by pulling a C# project with lean cloud pull, the following structure is created:

.
├── .vscode/
│   └── launch.json
├── config.json
├── <projectName>.csproj
├── Main.cs (only generated by lean create-project)
└── research.ipynb (only generated by lean create-project)

These files contain the following content:

FileContent
.vscode/launch.jsonThis file contains debug configuration to make debugging with VS Code easier.
config.jsonThis file contains the project configuration of the created project.
<projectName>.csprojThis file contains project configuration which Visual Studio, Rider, and VS Code can read to provide accurate C# autocomplete.
Main.csThis file contains a basic C# algorithm to help you get started.
research.ipynbThis file contains a C#-based research notebook which can be opened in a research environment.

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: