Prepare release

asherikov · Jul 8, 2024 · 5540125 · 5540125
1 parent 6bc9265
commit 5540125
Show file tree

Hide file tree

Showing 12 changed files with 70 additions and 34 deletions.
diff --git a/.github/workflows/master.yml b/.github/workflows/master.yml
@@ -9,7 +9,7 @@ jobs:
         runs-on: ubuntu-22.04
 
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
             - run: make install_deps_apt
             - run: make install
             - run: make test
@@ -19,11 +19,11 @@ jobs:
 
         steps:
             - name: main
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
               with:
                 path: "hiearch"
             - name: ccws
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
               with:
                 repository: "asherikov/ccws"
                 path: "ccws"

diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 build
+dist
diff --git a/Makefile b/Makefile
@@ -39,6 +39,7 @@ test:
 clean:
 	rm -Rf .pytest_cache
 	rm -Rf ${BUILD_DIR}
+	rm -Rf dist
 	find ./ -name "__pycache__" | xargs rm -Rf
 
 builddir:
@@ -54,7 +55,22 @@ install_edit:
 
 install_deps: builddir
 	pip-compile --verbose --output-file ./${BUILD_DIR}/requirements.txt pyproject.toml
-	pip3 install -r ./${BUILD_DIR}/requirements.txt
+	pip install -r ./${BUILD_DIR}/requirements.txt
+
+# https://packaging.python.org/en/latest/tutorials/packaging-projects/
+install_release_deps:
+	pip install --upgrade build
+	pip install --upgrade twine
+
+upload_testpypi:
+	rm -Rf dist
+	python3.11 -m build
+	python3.11 -m twine upload --verbose --repository testpypi dist/*
+
+upload_pypi:
+	rm -Rf dist
+	python3.11 -m build
+	python3.11 -m twine upload --verbose dist/*
 
 uninstall: clean
 	pip uninstall -y ${PROJECT_NAME}

diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ Features
 
 - `hiearch` does not use a DSL, but rather parses a set of input `yaml` files
   in arbitrary order. The file contents get composed into a single description,
-  which in turn gets decomposed into views.
+  which, in turn, gets decomposed into views.
 
 - Description files have flat structure without nesting or inclusion and
   contain lists of the following objects: nodes, edges, and views. Hierarchical
@@ -95,7 +95,7 @@ views:
             </pre>
         </td>
         <td align="center">
-            <img src="test/07_trivial/view1.svg" alt="view1" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/07_trivial/view1.svg" alt="view1" />
             <br />
             view1
         </td>
@@ -132,21 +132,21 @@ views:
             </pre>
         </td>
         <td align="center">
-            <img src="test/08_node_realations/view1.svg" alt="view1" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/08_node_realations/view1.svg" alt="view1" />
             <br />
             view1
         </td>
     </tr>
     <tr>
         <td align="center">
-            <img src="test/08_node_realations/view2.svg" alt="view2" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/08_node_realations/view2.svg" alt="view2" />
             <br />
             view2
         </td>
     </tr>
     <tr>
         <td align="center">
-            <img src="test/08_node_realations/view3.svg" alt="view3" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/08_node_realations/view3.svg" alt="view3" />
             <br />
             view3
         </td>
@@ -178,14 +178,14 @@ views:
             </pre>
         </td>
         <td align="center">
-            <img src="test/09_tags/view1.svg" alt="view1" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/09_tags/view1.svg" alt="view1" />
             <br />
             view1
         </td>
     </tr>
     <tr>
         <td align="center">
-            <img src="test/09_tags/view2.svg" alt="view2" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/09_tags/view2.svg" alt="view2" />
             <br />
             view2
         </td>
@@ -204,7 +204,7 @@ nodes:
             </pre>
         </td>
         <td align="center">
-            <img src="test/10_minimal/default.svg" alt="default" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/10_minimal/default.svg" alt="default" />
             <br />
             default
         </td>
@@ -247,28 +247,28 @@ views:
             </pre>
         </td>
         <td align="center">
-            <img src="test/11_neighbors/view1.svg" alt="view1" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/11_neighbors/view1.svg" alt="view1" />
             <br />
             view1
         </td>
     </tr>
     <tr>
         <td align="center">
-            <img src="test/11_neighbors/view2.svg" alt="view2" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/11_neighbors/view2.svg" alt="view2" />
             <br />
             view2
         </td>
     </tr>
     <tr>
         <td align="center">
-            <img src="test/11_neighbors/view3.svg" alt="view3" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/11_neighbors/view3.svg" alt="view3" />
             <br />
             view3
         </td>
     </tr>
     <tr>
         <td align="center">
-            <img src="test/11_neighbors/view4.svg" alt="view4" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/11_neighbors/view4.svg" alt="view4" />
             <br />
             view4
         </td>
@@ -310,14 +310,14 @@ views:
             </pre>
         </td>
         <td align="center">
-            <img src="test/12_view_style/styled.svg" alt="styled" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/12_view_style/styled.svg" alt="styled" />
             <br />
             styled
         </td>
     </tr>
     <tr>
         <td align="center">
-            <img src="test/12_view_style/plain.svg" alt="plain" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/12_view_style/plain.svg" alt="plain" />
             <br />
             plain
         </td>
@@ -350,14 +350,14 @@ views:
             </pre>
         </td>
         <td align="center">
-            <img src="test/13_edge_labels/view1.svg" alt="view1" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/13_edge_labels/view1.svg" alt="view1" />
             <br />
             view1
         </td>
     </tr>
     <tr>
         <td align="center">
-            <img src="test/13_edge_labels/view2.svg" alt="view2" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/13_edge_labels/view2.svg" alt="view2" />
             <br />
             view2
         </td>
@@ -404,21 +404,21 @@ views:
             </pre>
         </td>
         <td align="center">
-            <img src="test/14_edge_style/view1.svg" alt="view1" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/14_edge_style/view1.svg" alt="view1" />
             <br />
             view1
         </td>
     </tr>
     <tr>
         <td align="center">
-            <img src="test/14_edge_style/view2.svg" alt="view2" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/14_edge_style/view2.svg" alt="view2" />
             <br />
             view2
         </td>
     </tr>
     <tr>
         <td align="center">
-            <img src="test/14_edge_style/view3.svg" alt="view3" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/14_edge_style/view3.svg" alt="view3" />
             <br />
             view3
         </td>
@@ -436,16 +436,16 @@ nodes:
       # https://www.svgrepo.com/svg/479843/duck-toy-illustration-3
       # https://www.svgrepo.com/svg/479405/casa-pictogram-5
       graphviz:
-        node_label_format: '<<table><tr><td><img src="icon_{id}.svg"/></td><td>{label}</td></tr></table>>'
-        scope_label_format: '<<table><tr><td><img src="icon_{id}.svg"/></td><td>Scope: {label}</td></tr></table>>'
+        node_label_format: '<<table><tr><td><img src="https://raw.githubusercontent.com/asherikov/hiearch/master/icon_{id}.svg"/></td><td>{label}</td></tr></table>>'
+        scope_label_format: '<<table><tr><td><img src="https://raw.githubusercontent.com/asherikov/hiearch/master/icon_{id}.svg"/></td><td>Scope: {label}</td></tr></table>>'
     - id: ["Test 2", test2]
       scope: test1
     - id: ["Test 3", test3]
       tags: []
       substitutions:
         suffix: '!'
       graphviz:
-        node_label_format: '<<table><tr><td><img src="icon_{style}.svg"/></td><td>{label}{suffix}</td></tr></table>>'
+        node_label_format: '<<table><tr><td><img src="https://raw.githubusercontent.com/asherikov/hiearch/master/icon_{style}.svg"/></td><td>{label}{suffix}</td></tr></table>>'
     - id: ["Test 4", test4]
       style: test3
 views:
@@ -466,17 +466,17 @@ the included images must be present in the output directory.
 <table>
     <tr>
         <td align="center">
-            <img src="test/15_formatted_labels/view1.png" alt="view1" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/15_formatted_labels/view1.png" alt="view1" />
             <br />
             view1
         </td>
         <td align="center">
-            <img src="test/15_formatted_labels/view2.png" alt="view2" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/15_formatted_labels/view2.png" alt="view2" />
             <br />
             view2
         </td>
         <td align="center">
-            <img src="test/15_formatted_labels/view3.png" alt="view3" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/15_formatted_labels/view3.png" alt="view3" />
             <br />
             view3
         </td>
@@ -513,7 +513,7 @@ nodes:
             </pre>
         </td>
         <td align="center">
-            <img src="test/06_multiscope/default.svg" alt="default" />
+            <img src="https://raw.githubusercontent.com/asherikov/hiearch/master/test/06_multiscope/default.svg" alt="default" />
             <br />
             default
         </td>

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,16 +4,35 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hiearch"
-version = "0.0.1"
-dependencies = [
-    "graphviz",
-    "pyyaml"
+version = "0.1.0"
+
+authors = [
+    { name="Alexander Sherikov", email="asherikov@yandex.com" },
 ]
 
+description = "Generates multi-view diagrams from textual descriptions"
+
+readme = "README.md"
+
+# https://pypi.org/classifiers/
 classifiers = [
+    "Development Status :: 4 - Beta",
     "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering :: Visualization",
+]
+
+requires-python = ">=3.8"
+
+dependencies = [
+    "graphviz",
+    "pyyaml"
 ]
 
 [project.scripts]
 hiearch = "hiearch.hiearch:main"
 
+[project.urls]
+Homepage = "https://github.com/asherikov/hiearch"
+Issues = "https://github.com/asherikov/hiearch/issues"
diff --git a/hiearch/__init__.py → src/hiearch/__init__.py b/hiearch/__init__.py → src/hiearch/__init__.py
diff --git a/hiearch/graphviz.py → src/hiearch/graphviz.py b/hiearch/graphviz.py → src/hiearch/graphviz.py
diff --git a/hiearch/hh_edge.py → src/hiearch/hh_edge.py b/hiearch/hh_edge.py → src/hiearch/hh_edge.py
diff --git a/hiearch/hh_node.py → src/hiearch/hh_node.py b/hiearch/hh_node.py → src/hiearch/hh_node.py
diff --git a/hiearch/hh_view.py → src/hiearch/hh_view.py b/hiearch/hh_view.py → src/hiearch/hh_view.py
diff --git a/hiearch/hiearch.py → src/hiearch/hiearch.py b/hiearch/hiearch.py → src/hiearch/hiearch.py
diff --git a/hiearch/util.py → src/hiearch/util.py b/hiearch/util.py → src/hiearch/util.py