Add poetry dependency manager

Author: mr-pylin

README.md

@@ -1,12 +1,12 @@
 # 🔢 NumPy Workshop
 
-[![License](https://img.shields.io/github/license/mr-pylin/numpy-workshop)](https://github.com/mr-pylin/numpy-workshop/blob/main/LICENSE)
-[![Python Version](https://img.shields.io/badge/Python-3.12.3-blue?logo=python&logoColor=white)](https://www.python.org/downloads/release/python-3123/)
+[![License](https://img.shields.io/github/license/mr-pylin/numpy-workshop?color=blue)](https://github.com/mr-pylin/numpy-workshop/blob/main/LICENSE)
+[![Python Version](https://img.shields.io/badge/Python-3.12.8-yellow?logo=python&logoColor=white)](https://www.python.org/downloads/release/python-3128/)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/1faf9d4577d3406a9ac65a4cb8d3d4f1)](https://app.codacy.com/gh/mr-pylin/numpy-workshop/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
-[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-![Repo Size](https://img.shields.io/github/repo-size/mr-pylin/numpy-workshop)
-![Last Updated](https://img.shields.io/github/last-commit/mr-pylin/numpy-workshop)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen)](https://github.com/mr-pylin/numpy-workshop/pulls)
+[![Code Style](https://img.shields.io/badge/code%20style-black-black.svg)](https://github.com/psf/black)
+![Repo Size](https://img.shields.io/github/repo-size/mr-pylin/numpy-workshop?color=lightblue)
+![Last Updated](https://img.shields.io/github/last-commit/mr-pylin/numpy-workshop?color=orange)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen?color=brightgreen)](https://github.com/mr-pylin/numpy-workshop/pulls)
 
 An in-depth guide to mastering **NumPy**, covering fundamental to advanced array operations for **data science** and **numerical computing**.
 
@@ -72,36 +72,91 @@ An in-depth guide to mastering **NumPy**, covering fundamental to advanced array
 
 ## ⚙️ Setup
 
-This project requires Python **v3.10** or higher. It was developed and tested using Python **v3.12.3**. If you encounter issues running the specified version of dependencies, consider using this version of Python.
+This project requires Python **v3.10** or higher. It was developed and tested using Python **v3.12.8**. If you encounter issues running the specified version of dependencies, consider using this version of Python.
 
 ### 📝 List of Dependencies
 
-Installing **matplotlib** and **pandas** is **OPTIONAL**. They are used exclusively in the [**Looking Ahead Notebook**](./code/21-looking-ahead.ipynb) to show an application of using them.
+Installing `matplotlib` and `pandas` is **OPTIONAL**. They are used exclusively in the [**Looking Ahead Notebook**](./code/21-looking-ahead.ipynb) to show an application of using them.
 
-[![numpy](https://img.shields.io/badge/numpy-2.1.3-orange)](https://pypi.org/project/numpy/2.1.3/)
-[![matplotlib](https://img.shields.io/badge/matplotlib-3.9.1-green)](https://pypi.org/project/matplotlib/3.9.1/)
-[![pandas](https://img.shields.io/badge/pandas-2.2.2-yellow)](https://pypi.org/project/pandas/2.2.2/)
+[![ipykernel](https://img.shields.io/badge/ipykernel-6.29.5-ff69b4)](https://pypi.org/project/ipykernel/6.29.5/)
+[![ipywidgets](https://img.shields.io/badge/ipywidgets-8.1.5-ff6347)](https://pypi.org/project/ipywidgets/8.1.5/)
+[![matplotlib](https://img.shields.io/badge/matplotlib-3.10.0-green)](https://pypi.org/project/matplotlib/3.10.0/)
+[![numpy](https://img.shields.io/badge/numpy-2.2.1-orange)](https://pypi.org/project/numpy/2.2.1/)
+[![pandas](https://img.shields.io/badge/pandas-2.2.3-yellow)](https://pypi.org/project/pandas/2.2.3/)
 
-### 📦 Installing Dependencies
+### 📦 Install Dependencies
 
-You can install all dependencies listed in [**requirements.txt**](./requirements.txt) using [**pip**](https://pip.pypa.io/en/stable/installation/):
+#### 📦 Method 1: Poetry (Recommended)
+
+Use [**Poetry**](https://python-poetry.org/) for dependency management. It handles dependencies, virtual environments, and locking versions more efficiently than pip. To install dependencies using Poetry:
+
+- **Option 1 [Recommended]**: Install exact dependency versions specified in [**poetry.lock**](./poetry.lock) for consistent environments:
+
+ ```bash
+ poetry install
+ ```
+
+- **Option 2**: Install the latest compatible dependency versions from [**pyproject.toml**](./pyproject.toml) and regenerate the [**poetry.lock**](./poetry.lock) file:
+
+ ```bash
+ poetry install --no-root
+ ```
+
+#### 📦 Method 2: Pip
+
+Install all dependencies listed in [**requirements.txt**](./requirements.txt) using [**pip**](https://pip.pypa.io/en/stable/installation/):
 
 ```bash
 pip install -r requirements.txt
 ```
 
+#### 🌐 Connection Issues
+
+If you encounter connection issues during installation, you can try extending the **timeout** and increasing the number of **retries** with the following:
+
+- **For Poetry**: Use the following command to set the retries and timeout directly in the terminal **before running the install**:
+ - **Windows**:
+ - **PowerShell**:
+
+ ```bash
+ $env:POETRY_HTTP_TIMEOUT=300
+ $env:POETRY_HTTP_RETRIES=10
+ ```
+
+ - **Command Prompt**:
+
+ ```bash
+ set POETRY_HTTP_TIMEOUT=300
+ set POETRY_HTTP_RETRIES=10
+ ```
+
+ - **Linux/macOS**:
+ - **Terminal**:
+
+ ```bash
+ export POETRY_HTTP_TIMEOUT=300
+ export POETRY_HTTP_RETRIES=10
+ ```
+
+- **For Pip**: Use the `--retries` and `--timeout` flags directly in your pip command:
+
+ ```bash
+ pip install -r requirements.txt --retries 10 --timeout 300
+ ```
+
 ### 🛠️ Usage Instructions
 
-1. Open the root folder with [**VS Code**](https://code.visualstudio.com/):
- - **Windows/Linux**: `Ctrl + K` followed by `Ctrl + O`
- - **macOS**: `Cmd + K` followed by `Cmd + O`
-1. Open `.ipynb` files using [**Jupyter extension**](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter) integrated with **VS Code**.
-1. Allow **VS Code** to install any **recommended dependencies** for working with Jupyter Notebooks.
+1. Open the root folder with [**VS Code**](https://code.visualstudio.com/) (`Ctrl/Cmd + K` followed by `Ctrl/Cmd + O`).
+1. Open `.ipynb` files using the [**Jupyter extension**](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter) integrated with **VS Code**.
+1. Select the correct Python kernel and virtual environment where the dependencies were installed.
+1. Allow **VS Code** to install any recommended dependencies for working with Jupyter Notebooks.
 
 ✍️ **Notes**: 
 
-- The **table of contents** embedded in the **notebooks** is not fully functional on **GitHub**!
-- To navigate the **table of contents** effectively, open the notebooks **locally** or view them via [**nbviewer**](https://nbviewer.org/github/mr-pylin/pytorch-workshop) for a better experience.
+- It is **highly recommended** to stick with the exact dependency versions specified in [**poetry.lock**](./poetry.lock) or [**requirements.txt**](./requirements.txt) rather than using the latest package versions. The repository has been **tested** on these versions to ensure **compatibility** and **stability**.
+- This repository is **actively maintained**, and dependencies are **updated regularly** to the latest **stable** versions.
+- The **table of contents** embedded in the **notebooks** may not function correctly on **GitHub**.
+- For an improved experience, open the notebooks **locally** or view them via [**nbviewer**](https://nbviewer.org/github/mr-pylin/numpy-workshop).
 
 ## 🔗 Useful Links
 

code/01-array-basics.ipynb

@@ -41,7 +41,7 @@
  },
  {
  "cell_type": "code",
- "execution_count": null,
+ "execution_count": 1,
  "metadata": {},
  "outputs": [],
  "source": [
@@ -410,7 +410,7 @@
  "author_github": "https://github.com/mr-pylin",
  "author_name": "Amirhossein Heydari",
  "kernelspec": {
- "display_name": "Python 3",
+ "display_name": "numpy-workshop-0psJcWas-py3.12",
  "language": "python",
  "name": "python3"
  },
@@ -424,7 +424,7 @@
  "name": "python",
  "nbconvert_exporter": "python",
  "pygments_lexer": "ipython3",
- "version": "3.12.3"
+ "version": "3.12.8"
  },
  "origin_repo": "https://github.com/mr-pylin/numpy-workshop"
  },

code/02-arithmetic-operations.ipynb

@@ -39,7 +39,7 @@
  },
  {
  "cell_type": "code",
- "execution_count": null,
+ "execution_count": 1,
  "metadata": {},
  "outputs": [],
  "source": [
@@ -74,7 +74,7 @@
  },
  {
  "cell_type": "code",
- "execution_count": null,
+ "execution_count": 2,
  "metadata": {},
  "outputs": [
  {
@@ -109,7 +109,7 @@
  },
  {
  "cell_type": "code",
- "execution_count": null,
+ "execution_count": 3,
  "metadata": {},
  "outputs": [
  {
@@ -172,7 +172,7 @@
  },
  {
  "cell_type": "code",
- "execution_count": null,
+ "execution_count": 4,
  "metadata": {},
  "outputs": [
  {
@@ -208,7 +208,7 @@
  },
  {
  "cell_type": "code",
- "execution_count": null,
+ "execution_count": 5,
  "metadata": {},
  "outputs": [
  {
@@ -275,7 +275,7 @@
  },
  {
  "cell_type": "code",
- "execution_count": null,
+ "execution_count": 6,
  "metadata": {},
  "outputs": [
  {
@@ -329,7 +329,7 @@
  "author_github": "https://github.com/mr-pylin",
  "author_name": "Amirhossein Heydari",
  "kernelspec": {
- "display_name": "Python 3",
+ "display_name": "numpy-workshop-0psJcWas-py3.12",
  "language": "python",
  "name": "python3"
  },
@@ -343,7 +343,7 @@
  "name": "python",
  "nbconvert_exporter": "python",
  "pygments_lexer": "ipython3",
- "version": "3.12.3"
+ "version": "3.12.8"
  },
  "origin_repo": "https://github.com/mr-pylin/numpy-workshop"
  },

code/03-comparative-operations.ipynb

@@ -39,7 +39,7 @@
  },
  {
  "cell_type": "code",
- "execution_count": null,
+ "execution_count": 1,
  "metadata": {},
  "outputs": [],
  "source": [
@@ -107,7 +107,7 @@
  },
  {
  "cell_type": "code",
- "execution_count": null,
+ "execution_count": 3,
  "metadata": {},
  "outputs": [
  {
@@ -199,7 +199,7 @@
  },
  {
  "cell_type": "code",
- "execution_count": null,
+ "execution_count": 5,
  "metadata": {},
  "outputs": [
  {
@@ -315,7 +315,7 @@
  "author_github": "https://github.com/mr-pylin",
  "author_name": "Amirhossein Heydari",
  "kernelspec": {
- "display_name": "Python 3",
+ "display_name": "numpy-workshop-0psJcWas-py3.12",
  "language": "python",
  "name": "python3"
  },
@@ -329,7 +329,7 @@
  "name": "python",
  "nbconvert_exporter": "python",
  "pygments_lexer": "ipython3",
- "version": "3.12.3"
+ "version": "3.12.8"
  },
  "origin_repo": "https://github.com/mr-pylin/numpy-workshop"
  },