Skip to content

Commit

Permalink
📝 update local setup documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JoseRZapata committed Mar 28, 2024
1 parent 0275508 commit c55039e
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions docs/local_setup.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 🏠 Local Dev environment setup
# 🛠️ Local Dev environment setup

I develop data science python projects in Linux OS or MAC OS. (For Windows OS I recommend [WSL] and run commands as Linux OS).

Expand All @@ -15,9 +15,11 @@ I setup my local development environment using the following steps:
3. Install [Pyenv] and after install set up the terminal for [Pyenv] - [Link to set up](https://github.com/pyenv/pyenv?tab=readme-ov-file#set-up-your-shell-environment-for-pyenv)
- Linux: `curl https://pyenv.run | bash`
- MAC: `brew install pyenv`
- **Check the installation version** executing in terminal: `pyenv --version` for help go to [pyenv installation help](https://github.com/pyenv/pyenv?tab=readme-ov-file#set-up-your-shell-environment-for-pyenv)
4. Install [Python] using [Pyenv] , at this time I am using Python 3.11
- `pyenv install 3.11` # Install Python 3.11 in computer
- `pyenv global 3.11` # Set Python 3.11 as global version
- **Check the installation version** executing in terminal: `python --version`
5. Install locally [Pipx] to Install and Run Python Applications in Isolated Environments
- Linux:

Expand All @@ -26,13 +28,17 @@ I setup my local development environment using the following steps:
python3 -m pipx ensurepath
```

- Check the installation version executing in terminal: `pipx --version`

- MAC:

```bash title="Install pipx in Mac os"
brew install pipx
pipx ensurepath
```

- Check the installation version executing in terminal: `pipx --version`

## 🐍 General Python tools

General Tools that I use to develop Python projects, The most important is [Poetry] and all this tools are installed using [Pipx] to have this tools in isolated environments, because applications runs in its own virtual environment to avoid dependencies conflicts and they are available everywhere.
Expand All @@ -41,12 +47,12 @@ General Tools that I use to develop Python projects, The most important is [Poet

1. [Poetry] to manage the dependencies and the virtual environment of the project.
- `pipx install poetry`
2. [Pip-audit] to local check the security of the dependencies of the project.
2. [Cruft] allows you to maintain all the necessary boilerplate for packaging and building projects separate from the code you intentionally write. Fully compatible with existing Cookiecutter templates.
- `pipx install cruft`
3. (optional) [Pip-audit] to local check the security of the dependencies of the project.
- `pipx install pip-audit`
3. [Actionlint] to check the syntax of the GitHub Actions configuration files of the project.
4. (optional) [Actionlint] to check the syntax of the GitHub Actions configuration files of the project.
- `pipx install actionlint`
4. [Cruft] allows you to maintain all the necessary boilerplate for packaging and building projects separate from the code you intentionally write. Fully compatible with existing Cookiecutter templates.
- `pipx install cruft`

## 📁 Start a new data science project

Expand Down

0 comments on commit c55039e

Please sign in to comment.