diff --git a/README.md b/README.md index b18c53d..273a5e3 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,17 @@ ## Install -> TBD +> **This package is not yet released.** +> +> ```bash +> pip install ipyprofiler +> ``` +> +> To also install optional python-specific integration: +> +> ```bash +> pip install ipyprofiler[pyinstrument] +> ``` ## Screenshots diff --git a/examples/files/requirements.txt b/examples/files/requirements.txt index 6307973..43b3773 100644 --- a/examples/files/requirements.txt +++ b/examples/files/requirements.txt @@ -1,3 +1,2 @@ -pyinstrument ipywidgets -ipyprofiler +ipyprofiler[pyinstrument] diff --git a/pyproject.toml b/pyproject.toml index 5536dec..bca9e23 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,12 @@ name = "ipyprofiler" description = "Jupyter Widgets for visualizing profiler data." version = "0.1.0" requires-python = ">=3.9" -dependencies = ["traitlets >=5.1", "ipywidgets >=7,<9"] +dependencies = [ + "ipywidgets >=7,<9", + "jinja2 >=3.0.3", + "traitlets >=5.1", +] +optional-dependencies.pyinstrument = ["pyinstrument >=4.6.1"] authors = [{name = "ipyprofiler contributors"}] readme = "README.md" classifiers = [