Skip to content

Commit

Permalink
docs: update Python docs to trigger CI
Browse files Browse the repository at this point in the history
  • Loading branch information
kentbull committed Aug 26, 2024
1 parent 89da405 commit 525bc29
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy-master.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ jobs:
git config --local user.name "GitHub Actions"
git fetch origin gh-pages
git switch gh-pages
git rebase master
- name: Remove old site directory
run: rm -rf ./site
Expand All @@ -46,7 +47,6 @@ jobs:
TIMESTAMP=$(date +"%Y-%m-%d %H:%M")
git add site/*
git commit -m "Update site with new build - $TIMESTAMP"
git rebase master
- name: Push changes to gh-pages branch
run: git push origin gh-pages --force
24 changes: 20 additions & 4 deletions docs/03_dev-guide/03-06-DevGuide_Code_Examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,11 +164,27 @@ getRandomnessFastNode()
### Python
This guide recommends you use Pipenv to manage Python versions as it simplifies the process.
1. First, [install Pipenv][INSTALL_PIPENV] with brew: `brew install pipenv`.
2. TBD
This guide recommends you use Pyenv to manage Python versions as it simplifies the process.
It also recommends you use Pipenv for managing project dependencies for your Python project.
1. First, [install Pyenv][INSTALL_PYENV] with brew: `brew install pyenv`.
2. Then [install Pipenv][INSTALL_PIPENV] with `brew install pipenv`.
3. Then install Python 3.12.3 with Pipenv: `pyenv install 3.12.3`.
4. Set Python 3.12.3 to be in use globally with `pyenv global 3.12.3`.
5. Set up your project directory, dependency management Pipfile, and your Python module.
```bash
mkdir myproject
cd myproject
touch main.py
touch Pipfile
```
6. Add the `reqests` library to your `Pipfile`:
```bash
pipenv install requests
```
7. TBD
[INSTALL_GO]: https://go.dev/doc/install
[INSTALL_NODEJS]: https://nodejs.org/en/download/package-manager
[INSTALL_PIPENV]: https://pipenv.pypa.io/en/latest/installation.html
[INSTALL_PYENV]: https://github.com/pyenv/pyenv?tab=readme-ov-file

0 comments on commit 525bc29

Please sign in to comment.