From 3e93df5d930aec8266683519e0cbec280ec056c0 Mon Sep 17 00:00:00 2001 From: Umar Farooq Ghumman <46414488+mail4umar@users.noreply.github.com> Date: Sat, 13 Jan 2024 00:52:05 -0600 Subject: [PATCH 1/4] Update README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 9b05c94a..1ebff7ef 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,16 @@ vsql or admintools, etc. and uses the lastest VerticaPy version. ``` make uninstall ``` +## VerticaPy Development + +In order to use VerticaPyLab for development of VerticaPy, the following changes can be made to create a VerticaPyLab image that does not have VerticaPy installed: + +1. ``cd`` into VerticaPyLab/docker-verticapy. Edit the ``requirements.txt`` file and remove "verticapy" from the list. +2. If you also want the installation to be light and remove unnecessary extensions, open the Dockerfile in the same directory and comment out from line 53 to 63 [This is optional] +3. Then ``cd`` into VerticaPyLab/etc and edit ``VerticaPyLab.conf.default``. The ``VERTICAPYLAB_IMG_VERSION=latest`` can be changed to any other tag except for "latest". For example: ``VERTICAPYLAB_IMG_VERSION="no_verticapy"``. +4. Then build the image by running ``make verticapylab-build`` in the terminal. +5. Lastly start-up the container using ``make verticapylab-start``. +6. Note that you also need to start Vertica separately by running ``make vertica-start``. ## Vertica CE Container @@ -188,3 +198,5 @@ For a short guide on contribution standards, see [CONTRIBUTING.md](CONTRIBUTING. ## Getting started on Windows See the [Windows guide](windows/README.md). + + From 2d0d377284ecbcfc24b9b35848820f339693e6f8 Mon Sep 17 00:00:00 2001 From: Umar Farooq Ghumman <46414488+mail4umar@users.noreply.github.com> Date: Sat, 13 Jan 2024 05:15:18 -0600 Subject: [PATCH 2/4] Update README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 1ebff7ef..8e140a69 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,24 @@ In order to use VerticaPyLab for development of VerticaPy, the following changes 5. Lastly start-up the container using ``make verticapylab-start``. 6. Note that you also need to start Vertica separately by running ``make vertica-start``. +Once VerticaPyLab is up and running. You can copy/clone the latest VerticaPy repo into the ``VerticaPyLab/project/data`` directory. + +And then it can be installed using the below command from within the Jupyter Notebook or Terminal while you are inside the VerticaPy directory: + +``` +pip install . +``` + +If you want to make changes and test them, then simple unisntall VerticaPy using: + +``` +pip uninstall -y verticapy +``` + +Then re-install it. + +Note: For Jupyter Notebook you will need to refresh the kernel after the new installation. + ## Vertica CE Container 1. To create and start a new Vertica database: From 424d2bd76a4be8d499a95f3e6b9442290624c772 Mon Sep 17 00:00:00 2001 From: Umar Farooq Ghumman Date: Wed, 28 Feb 2024 07:57:29 -0600 Subject: [PATCH 3/4] Update README.md --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8e140a69..b7988b8b 100644 --- a/README.md +++ b/README.md @@ -44,11 +44,10 @@ vsql or admintools, etc. and uses the lastest VerticaPy version. In order to use VerticaPyLab for development of VerticaPy, the following changes can be made to create a VerticaPyLab image that does not have VerticaPy installed: 1. ``cd`` into VerticaPyLab/docker-verticapy. Edit the ``requirements.txt`` file and remove "verticapy" from the list. -2. If you also want the installation to be light and remove unnecessary extensions, open the Dockerfile in the same directory and comment out from line 53 to 63 [This is optional] -3. Then ``cd`` into VerticaPyLab/etc and edit ``VerticaPyLab.conf.default``. The ``VERTICAPYLAB_IMG_VERSION=latest`` can be changed to any other tag except for "latest". For example: ``VERTICAPYLAB_IMG_VERSION="no_verticapy"``. -4. Then build the image by running ``make verticapylab-build`` in the terminal. -5. Lastly start-up the container using ``make verticapylab-start``. -6. Note that you also need to start Vertica separately by running ``make vertica-start``. +2. Then ``cd`` into VerticaPyLab/etc and edit ``VerticaPyLab.conf.default``. The ``VERTICAPYLAB_IMG_VERSION=latest`` can be changed to any other tag except for "latest". For example: ``VERTICAPYLAB_IMG_VERSION="no_verticapy"``. +3. Then build the image by running ``make verticapylab-build`` in the terminal. +4. Lastly start-up the container using ``make verticapylab-start``. +5. Note that you also need to start Vertica separately by running ``make vertica-start``. Once VerticaPyLab is up and running. You can copy/clone the latest VerticaPy repo into the ``VerticaPyLab/project/data`` directory. @@ -66,7 +65,7 @@ pip uninstall -y verticapy Then re-install it. -Note: For Jupyter Notebook you will need to refresh the kernel after the new installation. +Note: For your changes to take effect, you must refresh the kernel after the new installation. ## Vertica CE Container From 0f088c0ad557a370e0e627c7904b5456ad5b6b55 Mon Sep 17 00:00:00 2001 From: Umar Farooq Ghumman Date: Wed, 28 Feb 2024 10:03:38 -0600 Subject: [PATCH 4/4] typo correction --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b7988b8b..dac0541a 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ And then it can be installed using the below command from within the Jupyter Not pip install . ``` -If you want to make changes and test them, then simple unisntall VerticaPy using: +If you want to make changes and test them, then simple uninstall VerticaPy using: ``` pip uninstall -y verticapy