Skip to content

Commit

Permalink
docs: 📝 improve dev onboarding
Browse files Browse the repository at this point in the history
  • Loading branch information
miragecentury committed Aug 23, 2024
1 parent 0080fa6 commit 422b0ae
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 2 deletions.
52 changes: 50 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,70 @@ Project Empty for Python with Poetry

### Dev Tools

#### Python

<https://www.python.org/downloads/>

```bash
sudo apt install software-properties-common -y
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
sudo apt install python3.12 -y
```

#### Poetry

<https://python-poetry.org/>

```bash
curl -sSL https://install.python-poetry.org | python3.12 -
```

#### Pre-commit

Included in the project while in virtual environment
<https://pre-commit.com/>

#### Docker

<https://docs.docker.com/get-docker/>

#### Skaffold

<https://skaffold.dev>

```bash
curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/latest/skaffold-linux-amd64
chmod +x skaffold
sudo mv skaffold /usr/local/bin
```

#### Buildpacks

<https://buildpacks.io/>

```bash
sudo add-apt-repository ppa:cncf-buildpacks/pack-cli
sudo apt-get update
sudo apt-get install pack-cli
```

#### Paketo

Included with the usage of buildpacks
<https://paketo.io/>

### Dev Environment
### 1- Dev Environment

```bash
# Initialize python virtual environment and install dependencies
./scripts/setup_dev_env.sh

pre-commit run --all-files
```

### 2- Create ```shipmens```
### 2- Build and Run Application on Docker

```bash
skaffold dev
```
5 changes: 5 additions & 0 deletions scripts/setup_dev_env.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
#!/usr/bin/env bash

set -euo pipefail

# Poetry setup
poetry env use python3.12
poetry install --with test --sync
Expand All @@ -21,3 +23,6 @@ fi

# Create build directory if it doesn't exist
mkdir -p build

# Moving to the virtual environment
poetry shell

0 comments on commit 422b0ae

Please sign in to comment.