Make Zulip an optional dependency (#86)

Author: caizixian

.github/workflows/python.yml

@@ -17,9 +17,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install .
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          python -m pip install --upgrade pip setuptools build[virtualenv]
+          pip install .[tests]
       - name: Test with pytest
         run: |
           pytest
@@ -38,9 +37,8 @@ jobs:
 # https://github.com/python/mypy/issues/10600
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install .
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          python -m pip install --upgrade pip setuptools build[virtualenv]
+          pip install .[zulip,tests]
       - name: Test with mypy
         run: |
           mypy src/running

MANIFEST.in

@@ -4,12 +4,19 @@
 ## Installation
 `pip3 install running-ng`
 
-## Create a new release
+## Development setup
 ```console
-pip install --upgrade build
-python -m build
+virtualenv env
+source env/bin/activate
+pip install -U pip setuptools build[virtualenv]
 ```
 
+To make a distribution archives, run `python -m build` within the virtual environment.
+To run an editable build in the virtual environment, run `pip install -e .`.
+To install to user `site-packages`, run `pip install dist/running_ng-<VERSION>-py3-none-any.whl` outside the virtual environment.
+
+To install extra 
+
 ## Documentation
 Please refer to [this site](https://anupli.github.io/running-ng/) for up-to-date documentations.
 

README.md

@@ -1,24 +1,33 @@
 # Changelog
 ## Unreleased
 ### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+## [`v0.3.1` (2022-09-18)](https://github.com/anupli/running-ng/releases/tag/v0.3.1)
+### Added
 #### Base Syntax
 - Use the `$RUNNING_NG_PACKAGE_DATA` environment variable to refer to base configurations shipped with running-ng, such as `$RUNNING_NG_PACKAGE_DATA/base/runbms.yml`, regardless how you installed runnin-ng.
 #### Benchmark Suites
 - `DaCapo` gains an extra key `companion` to facilitate eBPF tracing programs.
 
 ### Changed
-
-### Deprecated
+- Overhauled Python packaging with PEP 517
+- `zulip` is now an optional Python dependency. Use `pip install running-ng[zulip]` if you want to use the `Zulip` `runbms` plugin.
 
 ### Removed
 - Dropping Python 3.6 support for users.
 #### Base Configurations
 - Removing AdoptOpenJDK from the base configuration files. AdoptOpenJDK is now replaced by Temurin.
 
-### Fixed
-
-### Security
-
 ## [`v0.3.0` (2022-03-19)](https://github.com/anupli/running-ng/releases/tag/v0.3.0)
 ### Added
 #### Modifiers

docs/src/changelog.md

@@ -1,5 +1,51 @@
 [build-system]
 requires = [
-    "setuptools>=62.3.0"
+    "setuptools>=62.3.0",
+    "setuptools-scm"
 ]
-build-backend = "setuptools.build_meta"
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "running-ng"
+description = "Running: Next Generation"
+readme = "README.md"
+requires-python = ">=3.7"
+license = {text = "Apache"}
+classifiers = [
+    'Development Status :: 3 - Alpha',
+    'Intended Audience :: Science/Research',
+    'License :: OSI Approved :: Apache Software License',
+    'Topic :: System :: Benchmark',
+    'Programming Language :: Python :: 3',
+]
+authors = [{name = "Zixian Cai", email = "u5937495@anu.edu.au"}]
+dependencies = [
+    "pyyaml~=6.0"
+]
+dynamic = ["version"]
+
+[project.urls]
+"Homepage" = "https://github.com/anupli/running-ng"
+"Bug Tracker" = "https://github.com/anupli/running-ng/issues"
+
+[project.optional-dependencies]
+zulip = [
+    "zulip~=0.8.2"
+]
+tests = [
+    "pytest~=7.1.3",
+    "types-PyYAML~=6.0.11",
+    "mypy~=0.971"
+]
+
+[project.scripts]
+running = "running.__main__:main"
+
+[tool.setuptools.dynamic]
+version = {attr = "running.__version__.__VERSION__"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+running = ["config/**/*.yml"]

pyproject.toml

@@ -60,4 +60,17 @@ def end_config(self, _hfac: Optional[float], _size: Optional[int], _bm: "Benchma
 # !!! Do NOT remove this import nor change its position
 # This is to make sure that the plugin classes are correctly registered
 from running.plugin.runbms.copyfile import CopyFile
-from running.plugin.runbms.zulip import Zulip
+if TYPE_CHECKING:
+    from running.plugin.runbms.zulip import Zulip
+else:
+    try:
+        from running.plugin.runbms.zulip import Zulip
+    except:
+        from running.util import register
+        @register(RunbmsPlugin)
+        class Zulip(RunbmsPlugin):
+            def __init__(self, **kwargs):
+                raise RuntimeError("Trying to create an instance of the Zulip "
+                "plugin for runbms, but the import failed. This is most likely due "
+                "to the required dependencies not being installed. Try pip install "
+                "running-ng[zulip] to install the extra dependencies.")