Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python Virtual Env #964

Open
wants to merge 14 commits into
base: feature/distributed-demo
Choose a base branch
from
7 changes: 6 additions & 1 deletion docs/developer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,17 +113,22 @@ option with care.
To manage collaboration by multiple developers on the software,
a development workflow is in place. Each developer should follow these steps:

<!--
TODO Insert before Use fork,branch ... when githooks works
hkirk marked this conversation as resolved.
Show resolved Hide resolved
1. Install git-hooks for the project.
hkirk marked this conversation as resolved.
Show resolved Hide resolved
-->

1. Fork of the main repository into your github account.
1. Setup
[Code Climate](https://docs.codeclimate.com/docs/getting-started-with-code-climate)
and
[Codecov](https://docs.codecov.com/docs/quick-start)
for your fork. The codecov does not require secret token
for public repositories.
1. Install git-hooks for the project.
1. Use
[Fork, Branch, PR](https://gun.io/news/2017/01/how-to-github-fork-branch-and-pull-request/)
workflow.
1. Active the Python Virtual Enviornment by calling (`./dtaas-venv/bin/activate`)
1. Work in your fork and open a PR from your working
branch to your `feature/distributed-demo` branch.
The PR will run all the github actions, code climate and codecov checks.
Expand Down
3 changes: 2 additions & 1 deletion script/base.sh
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ sudo apt-get install -y \
apache2-utils \
net-tools \
python3-dev \
python3-pip
python3-pip \
python3-env

sudo mkdir -p /etc/apt/keyrings
if [ ! -f /etc/apt/keyrings/docker.gpg ]
Expand Down
20 changes: 14 additions & 6 deletions script/env.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,20 @@ npx --yes playwright install-deps
#-------------
printf "\n\n Installing required python packages...."
sudo apt install -y python3-pip
sudo -H pip3 install mkdocs
sudo -H pip3 install mkdocs-material
sudo -H pip3 install python-markdown-math
sudo -H pip3 install mkdocs-open-in-new-tab
sudo -H pip3 install mkdocs-with-pdf
sudo -H pip3 install qrcode

python3 -m venv ./dtaas-venv
hkirk marked this conversation as resolved.
Show resolved Hide resolved

chmod +x ./dtaas-venv/bin/activate
./dtaas-venv/bin/activate

./dtaas-venv/bin/pip3 install mkdocs
./dtaas-venv/bin/pip3 install mkdocs-material
./dtaas-venv/bin/pip3 install python-markdown-math
./dtaas-venv/bin/pip3 install mkdocs-open-in-new-tab
./dtaas-venv/bin/pip3 install mkdocs-with-pdf
./dtaas-venv/bin/pip3 install qrcode

deactivate

# Install markdownlint
sudo apt-get install -y rubygems
Expand Down