Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

first draft of install #86

Merged
merged 2 commits into from
Nov 24, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 101 additions & 1 deletion docs/website/docs/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,104 @@ import Tabs from '@theme/Tabs';

## Set up environment

## Install `dlt` library
### Make sure you are using **Python 3.8, 3.9, or 3.10** and have `pip` installed

```bash
python3 --version
pip3 --version
```

### If not, then please follow the instructions below to install it

<Tabs values={[{"label": "Ubuntu", "value": "ubuntu"}, {"label": "macOS", "value": "macos"}, {"label": "Windows", "value": "windows"}]} groupId="operating-systems" defaultValue="ubuntu">
<TabItem value="ubuntu">

You can install Python 3.10 with an `apt` command.

```bash
sudo apt update
sudo apt install python3.10
sudo apt install python3.10-venv
```

</TabItem>
<TabItem value="macos">

Once you have installed [Homebrew](https://brew.sh), you can install Python 3.10.

```bash
brew update
brew install python@3.10
```

</TabItem>
<TabItem value="windows">

You need to install [Python 3.10 (64-bit version) for Windows](https://www.python.org/downloads/windows/).
After this, you can then install `pip`.

```bash
C:\> pip3 install -U pip
```

</TabItem>
</Tabs>

### Once Python is installed, you should create virtual environment

<Tabs values={[{"label": "Ubuntu", "value": "ubuntu"}, {"label": "macOS", "value": "macos"}, {"label": "Windows", "value": "windows"}]} groupId="operating-systems" defaultValue="ubuntu">

<TabItem value="ubuntu">

Create a new virtual environment by making a `./env` directory to hold it.
TyDunn marked this conversation as resolved.
Show resolved Hide resolved

```bash
python3 -m venv ./env
```

Activate the virtual environment:

```bash
source ./env/bin/activate
```

</TabItem>
<TabItem value="macos">

Create a new virtual environment by making a `./env` directory to hold it.

```bash
python3 -m venv ./env
```

Activate the virtual environment:

```bash
source ./env/bin/activate
```

</TabItem>
<TabItem value="windows">

Create a new virtual environment by making a `./env` directory to hold it.

```bat
C:\> python3 -m venv ./env
```

Activate the virtual environment:

```bat
C:\> .\env\Scripts\activate
```

</TabItem>
</Tabs>

## Install `dlt` library

You can install `dlt` in your virtual environment by running:

```bash
pip3 install -U python-dlt
```