diff --git a/docs/website/docs/plus/getting-started/installation.md b/docs/website/docs/plus/getting-started/installation.md index 40a2afe1b2..aa7631438b 100644 --- a/docs/website/docs/plus/getting-started/installation.md +++ b/docs/website/docs/plus/getting-started/installation.md @@ -3,12 +3,156 @@ title: Installation description: Installation information for dlt+ --- -# Installing +# Installation -We distribute packages via PyPI, for example to install `dlt-plus` package: +dlt+ requires a valid license to run, which you can obtain from dltHub by [joining our waiting list](https://info.dlthub.com/waiting-list). + +:::info Supported Python versions + +dlt+ currently supports Python versions 3.9-3.12. + +::: + +## Quickstart + +To install the `dlt-plus` package, run: ```sh pip install dlt-plus ``` -Please install a valid license before proceeding, as described below. \ No newline at end of file +Please install a valid license before proceeding, as described under [licensing](#licensing). + +## Setting up your environment + +### Configuration of the Python environment + +Check if your Python environment is configured: + +```sh +python --version +pip --version +``` + +If you have a different Python version installed or are missing pip, follow the instructions below to update your Python version and/or install `pip`. + + + + +You can install Python 3.10 with `apt`. + +```sh +sudo apt update +sudo apt install python3.10 +sudo apt install python3.10-venv +``` + + + + +On macOS, you can use [Homebrew](https://brew.sh) to install Python 3.10. + +```sh +brew update +brew install python@3.10 +``` + + + + +After installing [Python 3.10 (64-bit version) for Windows](https://www.python.org/downloads/windows/), you can install `pip`. + +```sh +C:\> pip3 install -U pip +``` + + + + +### Virtual environment + +We recommend working within a [virtual environment](https://docs.python.org/3/library/venv.html) when creating Python projects. +This way, all the dependencies for your current project will be isolated from packages in other projects. + + + + + +Create a new virtual environment in your working folder. This will create an `./env` directory where your virtual environment will be stored: + +```sh +python -m venv ./env +``` + +Activate the virtual environment: + +```sh +source ./env/bin/activate +``` + + + + +Create a new virtual environment in your working folder. This will create an `./env` directory where your virtual environment will be stored: + +```sh +python -m venv ./env +``` + +Activate the virtual environment: + +```sh +source ./env/bin/activate +``` + + + + +Create a new virtual environment in your working folder. This will create an `./env` directory where your virtual environment will be stored: + +```bat +C:\> python -m venv ./env +``` + +Activate the virtual environment: + +```bat +C:\> .\env\Scripts\activate +``` + + + + +### Install dlt+ + +You can now install dlt+ in your virtual environment by running: + +```sh +# install the newest dlt version or upgrade the existing version to the newest one +pip install -U dlt-plus +``` + +Please install a valid license before proceeding, as described under [licensing](#licensing). + +## Licensing + +Once you have a valid license, you can make it available to `dlt+` by specifying it in an environment variable: + +```sh +export RUNTIME__LICENSE="eyJhbGciOiJSUz...vKSjbEc===" +``` + +Or by adding it to your global `secrets.toml` file (located in `~/.dlt/`, or the path defined in your `DLT_SECRETS_TOML` environment variable): + +```toml +[runtime] +license="eyJhbGciOiJSUz...vKSjbEc===" +``` + +You can verify that the license was installed correctly and is valid by running: + +```sh +$ dlt license show +``` + +Our license terms can be found [here](). \ No newline at end of file