Contributing Datasets

Setting Up Your Environment

Introduction

This page explains how to set up your coding environment to create, develop, and test your dataset before you contribute to the Dataset Market.

Prerequisites

Working knowledge of C#. You also need to install .NET 6.0 Runtime and initialize the LEAN CLI.

Create Data Source Repository

Follow these steps to create a repository for your dataset:

  1. Open the Lean.DataSource.SDK repository and click Use this template.

    2. Start with the SDK repository instead of existing data source implementations because we periodically update the SDK repository.

  2. On the Create a new repository from Lean.DataSource.SDK page, set the repository name to Lean.DataSource.<vendorNameDatasetName> (for example, Lean.DataSource.XYZAirlineTicketSales).
  3. Click Create repository from template.
  4. Clone the Lean.DataSource.<vendorNameDatasetName> repository.
    5. $ git clone https://github.com/username/Lean.DataSource.<vendorNameDatasetName>.git
  5. If you're on a Linux terminal, in your Lean.DataSource.<vendorNameDatasetName> directory, change the access permissions of the bash script.
    6. $ chmod +x ./renameDataset
  6. In your Lean.DataSource.<vendorNameDatasetName> directory, run the renameDataset.sh bash script.
    7. $ renameDataset.sh

    The bash script replaces some placeholder text in the Lean.DataSource.<vendorNameDatasetName> directory and renames some files according to your dataset's <vendorNameDatasetName>.

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: