Merge pull request #123 from martius-lab/fkloss/release3.0

Prepare for releasing 3.0.0

CHANGELOG.md

@@ -6,7 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [//]: # (Note: {ref}/{doc} roles are used for references to the documentation)
 
-## Unreleased (3.0.0)
+## Unreleased
+
+## [3.0.0] - 2024-08-19
 
 ### Changed
 - **Breaking:** Drop support for Python versions < 3.8
@@ -110,13 +112,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `save_metrics_params` is deprecated.  Use `finalize_job` instead.
 
 
-## 2.5 - 2023-10-05
+## [2.5] - 2023-10-05
 
 **Last version supporting Python 3.6.**
 
 
 ## 2.4 - 2022-02-08
 
-## 2.1 - 2020-06-20
+## [2.1] - 2020-06-20
+
+## [2.0] - 2020-03-25
+
+---
 
-## 2.0 - 2020-03-25
+[Unreleased]: https://github.com/martius-lab/cluster_utils/compare/v3.0.0...HEAD
+[3.0.0]: https://github.com/martius-lab/cluster_utils/compare/v2.5...v3.0.0
+[2.5]: https://github.com/martius-lab/cluster_utils/compare/v2.1...v2.5
+[2.1]: https://github.com/martius-lab/cluster_utils/compare/v2.0...v2.1
+[2.0]: https://github.com/martius-lab/cluster_utils/releases/tag/v2.0

README.md

@@ -6,7 +6,7 @@ The package was developed in the [Autonomous Learning group](https://uni-tuebing
 
 **A note on support.**
 *cluster_utils* was initially developed for inhouse use.
-In particular, this means that documentation is sparse, and the user experience is suboptimal in some places.
+In particular, this means that documentation is sparse (though we're working on extending it), and the user experience is suboptimal in some places.
 We are open sourcing the package now because we think it could also be useful for other people in the machine learning community.
 However, we can only provide limited support for user questions and requests.
 
@@ -28,7 +28,7 @@ If you encounter any bugs or have suggestions for improvements, please submit an
 ## Installation
 
 ```
-pip install git+https://github.com/martius-lab/cluster_utils.git
+pip install "cluster_utils[runner]"
 ```
 
 See [documentation](https://martius-lab.github.io/cluster_utils/installation.html) for more details.

docs/conf.py

@@ -72,7 +72,7 @@
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
-release = "3.0-devel"
+release = "3.0.0"
 # The short X.Y version.
 version = "3.0"
 

docs/installation.rst

@@ -20,7 +20,7 @@ optional "runner" dependencies:**
 
 .. code-block:: bash
 
-   pip install "cluster_utils[runner] @ git+https://github.com/martius-lab/cluster_utils.git"
+   pip install "cluster_utils[runner]"
 
 
 .. _optional_dependencies:
@@ -34,7 +34,7 @@ mind that you should always also include the "runner" group:
 
 .. code-block:: bash
 
-   pip install "cluster_utils[runner,EXTRA] @ git+https://github.com/martius-lab/cluster_utils.git"
+   pip install "cluster_utils[runner,EXTRA]"
 
 where ``EXTRA`` should be replaced by one of the following identifiers (or multiple,
 separated by commas):

pyproject.toml

@@ -5,7 +5,12 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "cluster-utils"
 dynamic = ["version"]
-description = "Cluster utilities"
+description = """
+A tool for easily running hyperparameter optimization or grid search on Slurm or \
+HTCondor clusters.  It takes care of submitting and monitoring the jobs as well as \
+aggregating the results.\
+"""
+readme = "README.md"
 license = {file = "LICENSE"}
 requires-python = ">=3.8"
 authors = [
@@ -21,6 +26,11 @@ authors = [
 maintainers = [
     { email = "[email protected]" },
 ]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+]
 dependencies = [
     # NOTE: List only dependencies of the 'client' and 'base' sub-packages here.
     # Dependencies of the 'server' sub-package should go to the optional-dependencies.

src/cluster_utils/base/utils.py

@@ -27,7 +27,7 @@ def __init__(self, module: str, optional_dependency_group: str) -> None:
             You can do this with:
             ```
             # when installing directly from git:
-            pip install "cluster_utils[{group}] @ git+https://github.com/martius-lab/cluster_utils.git"
+            pip install "cluster_utils[{group}]"
 
             # when installing from local working copy:
             pip install ".[{group}]"