Merge pull request #1 from uliegecsm/make_package

feature: Add setup.py to allow installation
uliegecsm · Jul 3, 2024 · e2560d4 · e2560d4
2 parents 896790d + fc9f3de
commit e2560d4
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 4 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -19,9 +19,27 @@ jobs:
 
             - name: Prepare.
               run : |
-                    pip install -r requirements.txt
-                    pip install pytest
+                  pip install -r requirements.txt
+                  pip install pytest
 
             - name: Run tests.
               run : |
-                    PYTHONPATH=$PWD pytest tests/test_topology.py
+                  PYTHONPATH=$PWD pytest tests/test_topology.py
+
+    install-as-package:
+        runs-on: [ubuntu-latest]
+        container:
+            image: python:3.9
+        steps:
+            - name: Prepare.
+              run : |
+                  apt update
+                  apt --yes --no-install-recommends install hwloc
+
+            - name: Install as package.
+              run : |
+                  pip3 install git+https://github.com/uliegecsm/hwloc-xml-parser.git@${{ github.sha }}
+
+            - name: Test package.
+              run : |
+                  python3 -c "from hwloc_xml_parser.topology import SystemTopology; topo = SystemTopology()"
diff --git a/hwloc_xml_parser/__init__.py b/hwloc_xml_parser/__init__.py
diff --git a/topology.py → hwloc_xml_parser/topology.py b/topology.py → hwloc_xml_parser/topology.py
diff --git a/setup.py b/setup.py
@@ -0,0 +1,12 @@
+from setuptools import setup, find_packages
+
+setup(
+    name             = 'hwloc-xml-parser',
+    version          = '0.1',
+    install_requires = [
+        'typeguard',
+    ],
+    packages         = find_packages(),
+    license          = 'MIT',
+    url              = 'https://github.com/uliegecsm/hwloc-xml-parser'
+)
diff --git a/tests/test_topology.py b/tests/test_topology.py
@@ -2,7 +2,7 @@
 import unittest
 from unittest.mock import call
 
-from topology import SystemTopology
+from hwloc_xml_parser.topology import SystemTopology
 
 class TestSystemTopology:
     """