VerticaPy Development Instruction

README.md

@@ -39,6 +39,33 @@ 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. 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.
+
+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 uninstall VerticaPy using:
+
+```
+pip uninstall -y verticapy
+```
+
+Then re-install it.
+
+Note: For your changes to take effect, you must refresh the kernel after the new installation.
 
 ## Vertica CE Container
 
@@ -188,3 +215,5 @@ For a short guide on contribution standards, see [CONTRIBUTING.md](CONTRIBUTING.
 ## Getting started on Windows
 
 See the [Windows guide](windows/README.md).
+
+