From 7271a036948f8de58109f4e251ece8ecc5481999 Mon Sep 17 00:00:00 2001
From: khwong-c64 <kin.hin.wong.c@gmail.com>
Date: Thu, 18 Jan 2024 23:08:25 +0000
Subject: [PATCH] Implement `pip install magia-hdl[full]`

---
 README.md               |  4 ++++
 docs/external_module.md | 11 ++++++++++-
 pyproject.toml          |  4 ++++
 3 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3abf9a6..57e6f43 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,10 @@ Please refer to the [Magia Roadmap](docs/roadmap.md).
 
 ```bash
 pip install magia-hdl
+
+# Install with full dependencies if advanced features are required
+
+pip install magia-hdl[full]
 ```
 
 ## Examples
diff --git a/docs/external_module.md b/docs/external_module.md
index 7945e5c..df6d20c 100644
--- a/docs/external_module.md
+++ b/docs/external_module.md
@@ -12,7 +12,16 @@ Common Use-cases are importing IP core such as:
 
 ## Prerequisite
 
-We need to install [hdlConvertor](https://github.com/Nic30/hdlConvertor) for this feature.
+This feature requires extra packages to be installed.
+Install with full features by running:
+
+```bash
+pip install magia-hdl[full]
+```
+
+Or install the following packages manually:
+
+- [hdlConvertor](https://github.com/Nic30/hdlConvertor)
 
 Run the following command to install hdlConvertor, if you are running on Linux X86_64:
 
diff --git a/pyproject.toml b/pyproject.toml
index 27d5c31..a63ab84 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -37,8 +37,12 @@ keywords = [
     "Code Generation", "FPGA", "ASIC", "EDA", "RTL Design"
 ]
 
+[tool.poetry.extras]
+full = ["hdlConvertor-binary"]
+
 [tool.poetry.dependencies]
 python = "^3.9"
+hdlConvertor-binary = { version = "~2.3", optional=true }
 
 [tool.poetry.group.dev.dependencies]
 cocotb = "*"