Skip to content

Commit

Permalink
docs(README): add dev env setup
Browse files Browse the repository at this point in the history
  • Loading branch information
miragecentury committed Jul 25, 2024
1 parent 4937474 commit fec1490
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,18 @@ Project Empty for Python with Poetry

## Setup

### 1- Add ```.env```
### Dev Tools

Add ```.env``` file with content as
<https://www.python.org/downloads/>

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

<https://pre-commit.com/>

### Dev Environment

```bash
PATH="./src:./tests:$PATH"
PYTHONPATH="./src:./tests:$PYTHONPATH"
./scripts/setup_dev_env.sh
```

### 2- Create ```shipmens```
15 changes: 15 additions & 0 deletions scripts/setup_dev_env.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/usr/bin/env bash

# Poetry setup
poetry env use python3.12
poetry install --with test,dev
poetry update --sync

# Pre-commit setup
pre-commit install

cat > .env <<EOF
PATH="./src:./tests:\$PATH"
PYTHONPATH="./src:./tests:\$PYTHONPATH"
EOF

0 comments on commit fec1490

Please sign in to comment.