From 64d03c85c955b9861e42ee0c303508e974fc0f5a Mon Sep 17 00:00:00 2001 From: Davide Bortolami Date: Sun, 29 Mar 2020 22:45:34 +0100 Subject: [PATCH 1/7] fix stale issues messages --- .github/workflows/stale.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 7bbc0505..c1841de1 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -13,7 +13,7 @@ jobs: - uses: actions/stale@v1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} - stale-issue-message: 'Stale issue message' - stale-pr-message: 'Stale pull request message' + stale-issue-message: 'This issue has been automatically marked as stale. You have a week to explain why you believe this is an error.' + stale-pr-message: 'This PR has been automatically marked as stale. You have a week to explain why you believe this is an error.' stale-issue-label: 'no-issue-activity' - stale-pr-label: 'no-pr-activity' + stale-pr-label: 'no-pr-activity' \ No newline at end of file From 2e0a863ef7b47fc4c92062392df75ce59bdf63aa Mon Sep 17 00:00:00 2001 From: Davide Bortolami Date: Fri, 17 Apr 2020 00:34:22 +0100 Subject: [PATCH 2/7] Update documentation, add ssh-client to bench build, expose MariaDB port in development --- .devcontainer/docker-compose.yml | 2 ++ build/bench/Dockerfile | 1 + development/README.md | 29 ++++++++++++++++++++++++----- 3 files changed, 27 insertions(+), 5 deletions(-) diff --git a/.devcontainer/docker-compose.yml b/.devcontainer/docker-compose.yml index 43498259..383e60ef 100644 --- a/.devcontainer/docker-compose.yml +++ b/.devcontainer/docker-compose.yml @@ -8,6 +8,8 @@ services: volumes: - ../installation/frappe-mariadb.cnf:/etc/mysql/conf.d/frappe.cnf - mariadb-vol:/var/lib/mysql + ports: + - 3306:3306 redis-cache: image: redis:alpine diff --git a/build/bench/Dockerfile b/build/bench/Dockerfile index 78a2381c..8bb85e5f 100644 --- a/build/bench/Dockerfile +++ b/build/bench/Dockerfile @@ -39,6 +39,7 @@ RUN install_packages \ redis-tools \ rlwrap \ tk8.6-dev \ + ssh-client \ # VSCode container requirements net-tools \ # PYTHON diff --git a/development/README.md b/development/README.md index 2f08d3d1..cc01b0e9 100644 --- a/development/README.md +++ b/development/README.md @@ -47,7 +47,7 @@ Run the following commands in the terminal inside the container. You might need ```shell bench init --skip-redis-config-generation --frappe-branch version-12 frappe-bench -cd frappe-bench +cd frappe-bench∏ ``` ### Setup hosts @@ -78,6 +78,7 @@ sed -i '/redis/d' ./Procfile ### Create a new site with bench +Your installation already includes a site for [localhost](http://locahost:8000) You can create a new site with the following command: ```shell @@ -87,11 +88,20 @@ bench new-site sitename for example: ```shell -bench new-site localhost +bench new-site mysite.localhost ``` The command will ask the MariaDB root password. The default root password is `123`. -This will create a new site and a `localhost` directory under `frappe-bench/sites`. +This will create a new site and a `mysite.localhost` directory under `frappe-bench/sites`. +You may need to configure your system /etc/hosts if you're on Linux, Mac, or its Windows equivalent. + +### Launching + +To launch witho +```shell +bench new-site mysite.localhost +``` + Your website will now be accessible on [localhost on port 8000](http://locahost:8000) ### Set bench developer mode on the new site @@ -99,8 +109,17 @@ Your website will now be accessible on [localhost on port 8000](http://locahost: To develop a new app, the last step will be setting the site into developer mode. Documentation is available at [this link](https://frappe.io/docs/user/en/guides/app-development/how-enable-developer-mode-in-frappe). ```shell -bench set-config developer_mode 1 -bench clear-cache +bench --site my.site set-config developer_mode 1 +bench --site my.site clear-cache +``` + +### Install an app + +To install an app we need to fetch it from the appropriate git repo, then install in on the appropriate site + +```shell +bench get-app myapp https://github.com/myusername/myapp.git +bench --site my.site install-app myapp ``` ### Fixing MariaDB issues after rebuilding the container From 5f3c4df4ad24212f5b88aa2ed5c031b3ece3de11 Mon Sep 17 00:00:00 2001 From: Davide Bortolami Date: Fri, 17 Apr 2020 02:56:30 +0100 Subject: [PATCH 3/7] automatically install python extension --- .devcontainer/devcontainer.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 4bab99fc..4466fe8a 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -8,5 +8,8 @@ "dockerComposeFile": "./docker-compose.yml", "service": "frappe", "workspaceFolder": "/workspace/development", - "shutdownAction": "stopCompose" +"shutdownAction": "stopCompose", +"extensions": [ + "ms-python.python" +] } From 85a824753bd7e8845847407ad7339eb0bd73b53b Mon Sep 17 00:00:00 2001 From: Davide Bortolami Date: Fri, 17 Apr 2020 02:57:20 +0100 Subject: [PATCH 4/7] Improve documentation, including new instructions for jupyterlab --- development/README.md | 52 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 47 insertions(+), 5 deletions(-) diff --git a/development/README.md b/development/README.md index 2cc4c0d6..8ec4df64 100644 --- a/development/README.md +++ b/development/README.md @@ -2,10 +2,17 @@ ## Prerequisites +In order to start deveping you need to satisfy the folowing prerequisites: + - Docker - docker-compose - user added to docker group +It is recommended you allocate at least 4GB of RAM to docker: + +- [Instructions for Windows](https://docs.docker.com/docker-for-windows/#resources) +- [Instructions for MacOOS](https://docs.docker.com/docker-for-mac/#resources) + ## Bootstrap Containers for development Clone and change directory to frappe_docker directory @@ -47,7 +54,7 @@ Run the following commands in the terminal inside the container. You might need ```shell bench init --skip-redis-config-generation --frappe-branch version-12 frappe-bench -cd frappe-bench∏ +cd frappe-bench ``` ### Setup hosts @@ -115,14 +122,16 @@ bench --site my.site clear-cache ### Install an app -To install an app we need to fetch it from the appropriate git repo, then install in on the appropriate site +To install an app we need to fetch it from the appropriate git repo, then install in on the appropriate site: + +You can check [VSCode container remote extension documentation](https://code.visualstudio.com/docs/remote/containers#_sharing-git-credentials-with-your-container) regarding git creedential sharing. ```shell bench get-app myapp https://github.com/myusername/myapp.git bench --site my.site install-app myapp ``` -### Start development +### Start Frappe without debugging Execute following command from the `frappe-bench` directory. @@ -130,6 +139,8 @@ Execute following command from the `frappe-bench` directory. bench start ``` +You can now login with user `Administrator` and the password you choose when creating the site. + Note: To start bench with debugger refer section for debugging. ### Fixing MariaDB issues after rebuilding the container @@ -178,7 +189,7 @@ And enter the interactive shell for the development container with the following docker exec -e "TERM=xterm-256color" -w /workspace/development -it devcontainer_frappe_1 bash ``` -### Visual Studio Code Python Debugging +### Start Frappe with Visual Studio Code Python Debugging To enable Python debugging inside Visual Studio Code, you must first install the `ms-python.python` extension inside the container. @@ -199,4 +210,35 @@ honcho start \ worker_default ``` -This command starts all processes with the exception of Redis (which is already running in separate container) and the `web` process. The latter can can finally be started from the debugger tab of VSCode. +This command starts all processes with the exception of Redis (which is already running in separate container) and the `web` process. The latter can can finally be started from the debugger tab of VSCode by clicking on the "play" button. + +You can now login with user `Administrator` and the password you choose when creating the site. + +## Developing using the interactive console + +You can launch the interactive shell console with: + +```shell +bench console +``` + +To work with a more advanced interactive environment that supports full Jupyter Notebooks you can run JupyterLab inside the Python Venv, which will already be activated. + +First you'll need to foward port 8090 from your debug container. Launch VSCode command palette (cmd+shift+p or ctrl+shift+p), run the command `Forward a port` and type port `8090`. + +You can then install and launch jupyterlab appropriately: + +```shell +pip install jupyterlab +jupyter lab --ip=0.0.0.0 --no-browser --port=8090 +``` + +Then replace `my.site` with your site and run the following code in a Jupyter cell: + +```python +import frappe +frappe.init(site='my.site', sites_path='/workspace/development/frappe-bench/sites') +frappe.connect() +frappe.local.lang = frappe.db.get_default('lang') +frappe.db.connect() +``` \ No newline at end of file From 5f823fe37cee7c4277b01ec28d50d902d169cf50 Mon Sep 17 00:00:00 2001 From: Davide Bortolami Date: Fri, 17 Apr 2020 03:26:16 +0100 Subject: [PATCH 5/7] doc jupyter updates --- development/README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/development/README.md b/development/README.md index 8ec4df64..bb770c1b 100644 --- a/development/README.md +++ b/development/README.md @@ -216,26 +216,21 @@ You can now login with user `Administrator` and the password you choose when cre ## Developing using the interactive console -You can launch the interactive shell console with: +You can launch a simple interactive shell console in the terminal with: ```shell bench console ``` -To work with a more advanced interactive environment that supports full Jupyter Notebooks you can run JupyterLab inside the Python Venv, which will already be activated. +More likely, you may want to launch VSCoode interactive console based on Jupyter kernel. -First you'll need to foward port 8090 from your debug container. Launch VSCode command palette (cmd+shift+p or ctrl+shift+p), run the command `Forward a port` and type port `8090`. +Launch VSCode command palette (cmd+shift+p or ctrl+shift+p), run the command `Python: Select interpreter to start Jupyter server` and select `/workspace/development/frappe-bench/env/bin/python`. -You can then install and launch jupyterlab appropriately: +Then, run the commmand `Python: Show Python interactive windows` from the VSCode command palette. -```shell -pip install jupyterlab -jupyter lab --ip=0.0.0.0 --no-browser --port=8090 -``` +Replace `my.site` with your site and run the following code in a Jupyter cell: -Then replace `my.site` with your site and run the following code in a Jupyter cell: - -```python +```python import frappe frappe.init(site='my.site', sites_path='/workspace/development/frappe-bench/sites') frappe.connect() From ac85e3631129d90b762f50d609df815471e3542f Mon Sep 17 00:00:00 2001 From: Davide Bortolami Date: Fri, 17 Apr 2020 18:59:10 +0100 Subject: [PATCH 6/7] Typo --- development/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/development/README.md b/development/README.md index bb770c1b..63bc2b46 100644 --- a/development/README.md +++ b/development/README.md @@ -226,7 +226,7 @@ More likely, you may want to launch VSCoode interactive console based on Jupyter Launch VSCode command palette (cmd+shift+p or ctrl+shift+p), run the command `Python: Select interpreter to start Jupyter server` and select `/workspace/development/frappe-bench/env/bin/python`. -Then, run the commmand `Python: Show Python interactive windows` from the VSCode command palette. +Then, run the commmand `Python: Show Python interactive window` from the VSCode command palette. Replace `my.site` with your site and run the following code in a Jupyter cell: From 8397499e85aecd7b0d07ac9f491877e6682189bb Mon Sep 17 00:00:00 2001 From: Davide Bortolami Date: Fri, 17 Apr 2020 20:15:11 +0100 Subject: [PATCH 7/7] Fixes --- .devcontainer/docker-compose.yml | 2 -- development/README.md | 11 +---------- 2 files changed, 1 insertion(+), 12 deletions(-) diff --git a/.devcontainer/docker-compose.yml b/.devcontainer/docker-compose.yml index 383e60ef..43498259 100644 --- a/.devcontainer/docker-compose.yml +++ b/.devcontainer/docker-compose.yml @@ -8,8 +8,6 @@ services: volumes: - ../installation/frappe-mariadb.cnf:/etc/mysql/conf.d/frappe.cnf - mariadb-vol:/var/lib/mysql - ports: - - 3306:3306 redis-cache: image: redis:alpine diff --git a/development/README.md b/development/README.md index 63bc2b46..755ddaaf 100644 --- a/development/README.md +++ b/development/README.md @@ -102,15 +102,6 @@ The command will ask the MariaDB root password. The default root password is `12 This will create a new site and a `mysite.localhost` directory under `frappe-bench/sites`. You may need to configure your system /etc/hosts if you're on Linux, Mac, or its Windows equivalent. -### Launching - -To launch witho -```shell -bench new-site mysite.localhost -``` - -Your website will now be accessible on [localhost on port 8000](http://locahost:8000) - ### Set bench developer mode on the new site To develop a new app, the last step will be setting the site into developer mode. Documentation is available at [this link](https://frappe.io/docs/user/en/guides/app-development/how-enable-developer-mode-in-frappe). @@ -140,7 +131,7 @@ bench start ``` You can now login with user `Administrator` and the password you choose when creating the site. - +Your website will now be accessible on [on port 8000](http://locahost:8000) Note: To start bench with debugger refer section for debugging. ### Fixing MariaDB issues after rebuilding the container