rename commons to neutrons_standard

.github/workflows/test_and_deploy.yaml

@@ -8,8 +8,8 @@ on:
     tags: ["v*"]
 
 env:
-  PKG_NAME: commons
-  MODULE_NAME: commons
+  PKG_NAME: neutrons_standard
+  MODULE_NAME: neutrons_standard
 
 # cancel previous job if new commit is pushed
 concurrency:

README.md

@@ -56,18 +56,18 @@ channels = [
 ]
 
 [tool.pixi.dependencies]
-commons = "*"
+neutrons_standard = "*"
 
 [tool.pixi.package.run-dependencies]
-commons = "*"
+neutrons_standard = "*"
 ```
 
 Then import utilities:
 
 ```python
-from commons import Config
-from commons.decorators.singleton import Singleton
-from commons.time import timestamp, isoFromTimestamp
+from neutrons_standard import Config
+from neutrons_standard.decorators.singleton import Singleton
+from neutrons_standard.time import timestamp, isoFromTimestamp
 ```
 
 See [`readthedocs`](https://pythoncommons.readthedocs.io/en/latest/) for detailed documentation on each module.
@@ -114,7 +114,7 @@ Output will be in `docs/_build/html/`.
 
 ```
 PythonCommons/
-├── src/commons/              # Main package
+├── src/neutrons_standard/              # Main package
 │   ├── config.py             # Configuration management
 │   ├── time.py               # Time utilities
 │   └── decorators/

docs/config.rst

@@ -9,7 +9,7 @@ Quick Reference
 
 .. code-block:: python
 
-    from commons import Config
+    from neutrons_standard import Config
 
     # Access values
     Config["database.host"]                      # Dot-delimited lookup
@@ -169,7 +169,7 @@ Basic Usage
 
 .. code-block:: python
 
-    from commons import Config
+    from neutrons_standard import Config
 
     # Read values
     host = Config["database.host"]

docs/singleton.rst

@@ -9,7 +9,7 @@ Quick Reference
 
 .. code-block:: python
 
-    from commons.decorators.singleton import Singleton, reset_Singletons
+    from neutrons_standard.decorators.singleton import Singleton, reset_Singletons
     
     @Singleton
     class MyService:
@@ -96,7 +96,7 @@ Reset all singletons:
 
 .. code-block:: python
 
-    from commons.decorators.singleton import reset_Singletons
+    from neutrons_standard.decorators.singleton import reset_Singletons
     
     reset_Singletons()                      # Reset all
     reset_Singletons(fully_unwrap=True)     # Fully unwrap all
@@ -110,7 +110,7 @@ Pytest Fixture
 .. code-block:: python
 
     import pytest
-    from commons.decorators.singleton import reset_Singletons
+    from neutrons_standard.decorators.singleton import reset_Singletons
     
     @pytest.fixture(autouse=True)
     def reset_all_singletons():
@@ -201,7 +201,7 @@ Configuration Objects
 
 .. code-block:: python
 
-    from commons import Config  # Already a Singleton
+    from neutrons_standard import Config  # Already a Singleton
     
     # Config is single instance across app
     cfg = Config

docs/time.rst

@@ -9,7 +9,7 @@ Quick Reference
 
 .. code-block:: python
 
-    from commons.time import timestamp, parseTimestamp, isoFromTimestamp
+    from neutrons_standard.time import timestamp, parseTimestamp, isoFromTimestamp
 
     # Generate timestamps
     ts = timestamp()                              # Current time (float seconds)
@@ -86,7 +86,7 @@ Event Logging
 
 .. code-block:: python
 
-    from commons.time import timestamp, isoFromTimestamp
+    from neutrons_standard.time import timestamp, isoFromTimestamp
 
     events = []
     for event_type in ["login", "query", "logout"]:
@@ -101,7 +101,7 @@ Performance Measurement
 
 .. code-block:: python
 
-    from commons.time import timestamp
+    from neutrons_standard.time import timestamp
 
     start = timestamp()
     perform_operation()
@@ -113,7 +113,7 @@ Timestamp Conversion Round-Trip
 
 .. code-block:: python
 
-    from commons.time import timestamp, isoFromTimestamp, parseTimestamp
+    from neutrons_standard.time import timestamp, isoFromTimestamp, parseTimestamp
 
     # Original timestamp
     ts1 = timestamp()
@@ -130,7 +130,7 @@ Configuration Backup Timestamping
 
 .. code-block:: python
 
-    from commons.time import isoFromTimestamp, timestamp
+    from neutrons_standard.time import isoFromTimestamp, timestamp
     from pathlib import Path
 
     def backup_file(filepath):
@@ -147,7 +147,7 @@ Audit Trails
 
 .. code-block:: python
 
-    from commons.time import timestamp, isoFromTimestamp
+    from neutrons_standard.time import timestamp, isoFromTimestamp
 
     class AuditLog:
         def __init__(self):
@@ -169,7 +169,7 @@ Time Series Data
 
 .. code-block:: python
 
-    from commons.time import timestamp, isoFromTimestamp
+    from neutrons_standard.time import timestamp, isoFromTimestamp
 
     class TimeSeries:
         def __init__(self):
@@ -193,7 +193,7 @@ Database Integration
 
 .. code-block:: python
 
-    from commons.time import timestamp, isoFromTimestamp, parseTimestamp
+    from neutrons_standard.time import timestamp, isoFromTimestamp, parseTimestamp
 
     class DatabaseRecord:
         def __init__(self, data):
@@ -234,7 +234,7 @@ With ``ensureUnique=True``, timestamps strictly increase even in same second:
 
 .. code-block:: python
 
-    from commons.time import timestamp
+    from neutrons_standard.time import timestamp
 
     times = [timestamp(ensureUnique=True) for _ in range(100)]
 

pyproject.toml

@@ -2,7 +2,7 @@
 ### Project Metadata ###
 ########################
 [project]
-name = "commons"
+name = "neutrons_standard"
 description = "Python library repo for atomic software components generally applicable across neutrons repositories."
 dynamic = ["version"]
 requires-python = ">=3.10"
@@ -36,19 +36,19 @@ requires = ["hatchling", "versioningit"]
 source = "versioningit"
 
 [tool.hatch.build.hooks.versioningit-onbuild]
-source-file = "src/commons/_version.py"
-build-file = "commons/_version.py"
+source-file = "src/neutrons_standard/_version.py"
+build-file = "neutrons_standard/_version.py"
 
 [tool.hatch.build]
 artifacts = [
-  "src/commons/_version.py",
-  "src/commons/**/*.yml",
-  "src/commons/**/*.yaml",
-  "src/commons/**/*.ini",
+  "src/neutrons_standard/_version.py",
+  "src/neutrons_standard/**/*.yml",
+  "src/neutrons_standard/**/*.yaml",
+  "src/neutrons_standard/**/*.ini",
 ]
 
 [tool.hatch.build.targets.wheel]
-packages = ["src/commons"]
+packages = ["src/neutrons_standard"]
 
 [tool.versioningit.vcs]
 method = "git"
@@ -67,7 +67,7 @@ dirty = "{version}"
 distance-dirty = "{next_version}.dev{distance}"
 
 [tool.versioningit.write]
-file = "src/commons/_version.py"
+file = "src/neutrons_standard/_version.py"
 
 ###################
 ### Pixi config ###
@@ -101,7 +101,7 @@ pillow = ">=12.1.1"          # CVE-2026-25990
 
 [tool.pixi.pypi-dependencies]
 # PyPI dependencies, including this package to allow local editable installs
-commons = { path = ".", editable = true }
+neutrons_standard = { path = ".", editable = true }
 jaraco-context = ">=6.1.0"                     # CVE-2026-23949
 
 # Pixi Build configuration - https://pixi.sh/latest/reference/pixi_manifest/#pixi-build
@@ -116,7 +116,7 @@ numpy = "*"
 "ruamel.yaml" = "*"
 
 [tool.pixi.package]
-name = "commons"
+name = "neutrons_standard"
 version = "0.0.0"     # placeholder, overwritten by sync-version
 
 [tool.pixi.package.build]
@@ -211,7 +211,7 @@ reset-toml = { cmd = "cp pyproject.toml.bak pyproject.toml; rm pyproject.toml.ba
 ##############
 
 [tool.pytest.ini_options]
-addopts = "-v --cov=commons --cov-report=term-missing"
+addopts = "-v --cov=neutrons_standard --cov-report=term-missing"
 pythonpath = [".", "src", "scripts"]
 testpaths = ["tests"]
 python_files = ["test*.py"]
@@ -239,7 +239,7 @@ select = ["A", "ARG", "ASYNC", "BLE", "C90", "E", "F", "I", "N", "UP032", "W"]
 ignore = []
 
 [tool.ruff.lint.isort]
-known-first-party = ["commons"]
+known-first-party = ["neutrons_standard"]
 
 [tool.ruff.format]
 quote-style = "double"

src/commons/__init__.py → src/neutrons_standard/__init__.py

@@ -1,6 +1,6 @@
 """Contains the entry point for the application"""
 
-from commons.decorators.singleton import Singleton
+from neutrons_standard.decorators.singleton import Singleton
 
 
 try:

src/neutrons_standard/help/help_model.py

@@ -0,0 +1,12 @@
+"""single help module"""
+
+import webbrowser
+
+from neutrons_standard.configuration import get_data
+
+
+def help_function(context):
+    """Open a browser with the appropriate help page"""
+    help_url = get_data("global.other", "help_url")
+    if context:
+        webbrowser.open(help_url)

tests/conftest.py

@@ -3,10 +3,10 @@
 import os
 import pytest
 
-import commons
-from commons.decorators.singleton import reset_Singletons
+import neutrons_standard
+from neutrons_standard.decorators.singleton import reset_Singletons
 
-commons.init("commons")
+neutrons_standard.init("neutrons_standard")
 
 if not os.environ.get("env"):
     os.environ["env"] = "test"

tests/resources/application.yml

@@ -9,7 +9,7 @@ templated:
 
 user:
   application:
-      home: ~/.commons/
+      home: ~/.neutrons_standard/
 
 test:
   multi-substitution: