Skip to content

Commit 4d4eced

Browse files
committed
docs: add python installation instructions
This commit adds the python installation instruction for windows, macos, and linux to the backend dev environment setup page. [SCSE-22]
1 parent a510bb5 commit 4d4eced

4 files changed

Lines changed: 91 additions & 1 deletion

File tree

docs/backend/_python-linux.mdx

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
### Ubuntu
2+
3+
[deadsnakes PPA](https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa) contains more recent Python versions packaged for Ubuntu.
4+
5+
```bash
6+
$ sudo apt-get install software-properties-common
7+
$ sudo add-apt-repository ppa:deadsnakes/ppa
8+
$ sudo apt-get update
9+
$ sudo apt-get install python3.8
10+
```
11+
12+
### Other Linux distribution
13+
14+
If you are using other Linux distribution, `Python 3` is most likely preinstalled. If not, use your distribution's package manager to install it.
15+
16+
For example, on Fedora, you would use `dnf`:
17+
18+
```bash
19+
$ sudo dnf install python3
20+
```
21+
22+
And on ArchLinux, you would use `pacman`:
23+
24+
```bash
25+
$ sudo pacman -S python
26+
```
27+
28+
To check if it is installed correctly:
29+
30+
```bash
31+
python --version
32+
# Python 3.10.7
33+
# OR
34+
py --version
35+
#Python 3.10.7
36+
```

docs/backend/_python-macos.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
1. Download the `Python` installer package from the [official Python website](https://www.python.org/downloads/)
2+
1. It should detect your operating system and show a yellow download button. If it doesn’t, click the `windows` link and choose the latest Python release.
3+
1. Once the download is complete, double-click the package to start installing `Python`. Follow the installation steps with the default settings.
4+
1. Once installation is complete, you have python installed on your system!
5+
6+
To check if it is installed correctly:
7+
8+
```bash
9+
python --version
10+
# Python 3.10.7
11+
# OR
12+
py --version
13+
#Python 3.10.7
14+
```

docs/backend/_python-windows.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
1. Download the `Python` installer package from the [official Python website](https://www.python.org/downloads/)
2+
1. It should detect your operating system and show a yellow download button. If it doesn’t, click the `windows` link and choose the latest Python release.
3+
1. Once the download is complete, double-click the package to start installing `Python`. Follow the installation steps with the default settings.
4+
1. Once installation is complete, you have python installed on your system!
5+
6+
To check if it is installed correctly:
7+
8+
```bash
9+
python --version
10+
# Python 3.10.7
11+
# OR
12+
py --version
13+
#Python 3.10.7
14+
```

docs/backend/env-setup.mdx

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,32 @@ sidebar_position: 1
44

55
# Environment Setup
66

7+
```mdx-code-block
8+
import OsTabs from "@site/src/components/DocsFeatures/OsTabs.tsx"
9+
```
10+
711
Backend devs should have the following installed and configured as described below:
812

9-
## Python 3.x
13+
## Install `Python 3.x`
14+
15+
```mdx-code-block
16+
import PythonWindows from "./_python-windows.mdx"
17+
import PythonMacOS from "./_python-macos.mdx"
18+
import PythonLinux from "./_python-linux.mdx"
19+
20+
<OsTabs
21+
windows={<PythonWindows />}
22+
macos={<PythonMacOS />}
23+
linux={<PythonLinux />}
24+
/>
25+
```
26+
27+
## Install `poetry`
28+
29+
## Install `nvm` & `node.js`
30+
31+
Follow the instructions to install `nvm` & `node.js` [here](/docs/getting-started/node-nvm)
32+
33+
## Install serverless cli
34+
35+
## Install dynamodb offline

0 commit comments

Comments
 (0)