Merge pull request #190 from ivanyu/ivanyu/misc

Release 0.3.0 + README fix
ivanyu · Nov 20, 2022 · 0e31e0e · 0e31e0e
2 parents 3f89a47 + 557929a
commit 0e31e0e
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -59,12 +59,17 @@ The browser-based PyHeap UI is a convenient way to explore heap dumps. It can sh
 
 ![Thread view](doc/screenshot1.png)
 
+<details>
+  <summary>More screenshots</summary>
+
 ![Heap view](doc/screenshot2.png)
 
 ![Object view - Attributes](doc/screenshot3.png)
 
 ![Object view - Referents](doc/screenshot4.png)
 
+</details>
+
 #### Running with Docker
 
 Running the PyHeap UI with Docker is simple:
@@ -95,9 +100,12 @@ and open [http://127.0.0.1:5000](http://127.0.0.1:5000).
 
 ### Command-Line Heap Analyzer
 
+<details>
+  <summary>In case you cannot use the browser-based UI</summary>
+
 Analyze the heap with the `analyzer` module:
 ```bash
-$ PYTHONPATH=src -m analyzer retained-heap --file heap.pyheap
+$ PYTHONPATH=src poetry run python -m analyzer retained-heap --file heap.pyheap
 
 [2022-09-07 09:40:46,594] INFO Loading file heap.json.gz
 [2022-09-07 09:40:46,633] INFO Loading file finished in 0.04 seconds
@@ -129,6 +137,7 @@ Address         | Object type     | Retained heap size | String representation
 ...
 ```
 (in the repo root directory).
+</details>
 
 ## How It Works
 

diff --git a/integration_tests/pyproject.toml b/integration_tests/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyheap-integration-tests"
-version = "0.2.0"
+version = "0.3.0"
 description = ""
 authors = ["Ivan Yurchenko <[email protected]>"]
 license = "Apache License 2.0"

diff --git a/pyheap-ui/pyproject.toml b/pyheap-ui/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyheap-ui"
-version = "0.2.0"
+version = "0.3.0"
 description = ""
 authors = ["Ivan Yurchenko <[email protected]>"]
 license = "Apache License 2.0"

diff --git a/pyheap/pyproject.toml b/pyheap/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyheap"
-version = "0.2.0"
+version = "0.3.0"
 description = ""
 authors = ["Ivan Yurchenko <[email protected]>"]
 license = "Apache License 2.0"

diff --git a/test_inferiors/pyproject.toml b/test_inferiors/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "test-inferiors"
-version = "0.2.0"
+version = "0.3.0"
 description = ""
 authors = ["Ivan Yurchenko <[email protected]>"]
 readme = "README.md"