Update installation instructions and virtual environment setup.

Author: ebezzam

README.rst

@@ -88,10 +88,26 @@ This "dummy" package can be installed with pip:
 
     pip install pydevtips
 
-Or from source, e.g. with Anaconda / Miniconda:
+Or from source. Firstly, `Poetry <https://python-poetry.org/docs/#installation>`_
+must be installed. 
 
 .. code:: bash
 
+    # -- recommend using pipx
+    pipx install poetry
+
+    # -- or with official installer
+    # curl -sSL https://install.python-poetry.org | python3 -
+
+
+Then the following commands can be run:
+
+.. code:: bash
+
+    # get source code
+    git clone [email protected]:ebezzam/python-dev-tips.git
+    cd python-dev-tips
+
     # create new environment, press enter to accept
     # -- important to set python version, otherwise `python` executable may not exist 
     # -- (would be `python3` instead)
@@ -106,12 +122,37 @@ Or from source, e.g. with Anaconda / Miniconda:
     # install package locally
     (project_env) poetry install --with dev
 
+    # install pre-commit hooks
+    (project_env) pre-commit install
+
     # run tests
-    (project_env) poetry run pytest
+    (project_env) pytest
 
     # deactivate environment
     (project_env) conda deactivate
 
+Or with just Poetry:
+
+.. code:: bash
+
+    # get source code
+    git clone [email protected]:ebezzam/python-dev-tips.git
+    cd python-dev-tips
+
+    # install package locally
+    poetry install --with dev
+    # -- `poetry env info` to see where the virtual environment is located
+
+    # install pre-commit hooks
+    poetry run pre-commit install
+
+    # run tests
+    poetry run pytest
+
+    ## NOTE that Python related commands need to be run 
+    ## with `poetry run` or by activating the virtual environment
+    ## https://python-poetry.org/docs/basic-usage/#activating-the-virtual-environment
+
 Examples
 ========
 

docs/source/virtual_env.rst

@@ -16,7 +16,9 @@ you create a new environment like so:
 .. code:: bash
 
     # create new environment, press enter to accept
-    conda create -n project_env python=3.9
+    # -- important to set python version, otherwise `python` executable may not exist 
+    # -- (would be `python3` instead)
+    conda create -n project_env python=3.11
 
     # view available environments
     conda info --envs
@@ -58,6 +60,12 @@ You can identify the location and info of the Poetry virtual environment by runn
 
     poetry env info
 
+You can also configure to create the virtual environment within the project folder:
+
+.. code:: bash
+
+    poetry config virtualenvs.in-project true
+
 
 Sharing your environment
 ------------------------
@@ -100,7 +108,7 @@ storing and keeping track of packages:
     
         conda env list
 
-    The the name of the environment is specified at the top of ``environment.yml``.
+    The name of the environment is specified at the top of ``environment.yml``.
 
     Note that this approach is specific to Anaconda / Miniconda. More 
     information can be found 

environment.yml

@@ -1,4 +1,4 @@
-name: project_env
+name: project_env_yml
 channels:
   - defaults
 dependencies: