PyroLab 0.4.0__tar.gz → 0.5.0rc2__tar.gz

{pyrolab-0.4.0/pyrolab.egg-info → pyrolab-0.5.0rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyrolab
-Version: 0.4.0
+Version: 0.5.0rc2
 Summary: A framework for using remote lab instruments as local resources built on Pyro5.
 Author-email: Sequoia Ploeg <sequoiap4@gmail.com>, BYU CamachoLab <camacho@byu.edu>
 Maintainer-email: Sequoia Ploeg <sequoiap4@gmail.com>, BYU CamachoLab <camacho@byu.edu>
@@ -18,24 +18,23 @@ Classifier: Intended Audience :: Developers
 Classifier: Topic :: Scientific/Engineering
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE.txt
 Requires-Dist: numpy
 Requires-Dist: scipy
 Requires-Dist: Pyro5
-Requires-Dist: pydantic<2.0.0,>=1.9.1
+Requires-Dist: pydantic<3,>=2.8
 Requires-Dist: pyyaml
 Requires-Dist: deprecation
 Requires-Dist: typer
@@ -43,6 +42,7 @@ Requires-Dist: colorama
 Requires-Dist: tabulate
 Requires-Dist: requests
 Requires-Dist: packaging>=23.0
+Requires-Dist: platformdirs>=3.0
 Provides-Extra: tsl550
 Requires-Dist: pyserial; extra == "tsl550"
 Provides-Extra: ppcl55x
@@ -52,25 +52,8 @@ Requires-Dist: pyvisa; extra == "rto"
 Requires-Dist: pyvisa-py; extra == "rto"
 Provides-Extra: arduino
 Requires-Dist: pyfirmata; extra == "arduino"
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: coverage; extra == "test"
-Provides-Extra: dev
-Requires-Dist: notebook; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: coverage; extra == "dev"
-Requires-Dist: flake8>=4.0.1; extra == "dev"
-Requires-Dist: isort>=5.10.1; extra == "dev"
-Requires-Dist: black>=22.1.0; extra == "dev"
-Requires-Dist: autopep8>=1.6.0; extra == "dev"
-Requires-Dist: twine>=4.0.0; extra == "dev"
-Requires-Dist: build>=0.10.0; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: bump2version~=1.0.1; extra == "dev"
-Provides-Extra: docs
-Requires-Dist: jupyter-book==1.0.3; extra == "docs"
-Requires-Dist: numpydoc==1.5.0; extra == "docs"
+Provides-Extra: cameras
+Requires-Dist: opencv-python; extra == "cameras"
 Dynamic: license-file
 
 <p align="center">
@@ -80,7 +63,6 @@ Dynamic: license-file
 ---
 
 <p align="center">
-<img alt="Development version" src="https://img.shields.io/badge/master-v0.4.0-informational">
 <a href="https://pypi.python.org/pypi/pyrolab"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/pyrolab.svg"></a>
 <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/pyrolab">
 <a href="https://pyrolab.readthedocs.io/"><img alt="Documentation Status" src="https://readthedocs.org/projects/pyrolab/badge/?version=latest"></a>
@@ -118,7 +100,7 @@ PyroLab declares several "extras", depending on which instruments you need
 to support:
 
 ```
-pip install pyrolab[tsl550, oscope]
+pip install "pyrolab[tsl550,rto]"
 ```
 
 The full list of supported extras is:
@@ -126,18 +108,24 @@ The full list of supported extras is:
 - ``ppcl55x`` (PurePhotonics lasers)
 - ``rto`` (Rohde & Schwarz oscilloscopes)
 - ``arduino`` (Arduino)
-- ``test`` (PyroLab unit testing)
+- ``cameras`` (ThorCam and AmScope cameras, via OpenCV)
 <!-- - ``thorlabs`` (ThorLabs motion controllers) -->
 <!-- - ``adiscovery`` (Analog Discovery boards from Digilent) -->
 <!-- - ``monitor`` (PyroMonitor web application) -->
 
 You can also clone the repository, navigate to the toplevel, and install in 
-editable mode (make sure you have pip >= 21.1):
+editable mode:
 
 ```
 pip install -e .
 ```
 
+For development, use [uv](https://docs.astral.sh/uv/). From the toplevel,
+``make install`` (equivalent to ``uv sync --all-extras`` followed by
+``uv run pre-commit install``) creates a ``.venv`` with PyroLab, every extra,
+and the development tools, and installs the pre-commit hooks. Run tests with
+``make test`` (or ``uv run pytest``).
+
 ## Web Monitor
 
 There's a web application that can monitor your PyroLab nameserver and 
@@ -181,6 +169,7 @@ Run a nameserver:
 
 ```python
 from pyrolab.api import start_ns_loop
+
 start_ns_loop()
 ```
 
@@ -252,48 +241,61 @@ arrays, matplotlib plot objects, custom objects, etc.).
 
 ## Releasing
 
-Make sure you have committed a changelog file under ``docs/changelog`` titled 
-``<major>.<minor>.<patch>-changelog.md`` before bumping version. Also, the git
-directory should be clean (no uncommitted changes).
+The version lives only in ``pyproject.toml``; ``pyrolab.__version__`` reads it
+from the installed package's metadata.
 
-To bump version prior to a release, run one of the following commands:
+Every release starts as a release candidate on PyPI, so what gets tested is
+exactly what gets released. First commit a changelog file under
+``docs/changelog`` titled ``<major>.<minor>.<patch>-changelog.md`` for the new
+version; it becomes the release notes for the candidates and the release. Then,
+with a clean working tree:
 
 ```
-bumpversion major
-bumpversion minor
-bumpversion patch
+make minor      # start a candidate: 0.4.0 -> 0.5.0rc1 (or make patch, make major)
+make rc         # if you need another: 0.5.0rc1 -> 0.5.0rc2
+make release    # release the candidate: 0.5.0rc2 -> 0.5.0
 ```
 
-This will automatically create a git tag in the repository with the 
-corrresponding version number and commit the modified files (where version
-numbers were updated). Pushing the tags (a manual process) to the remote will 
-automatically create a new release. Releases are automatically published to 
-PyPI and GitHub when git tags matching the "v*" pattern are created 
-(e.g. "v0.4.0"), as bumpversion does.
-
-After bumping version, you can view the tags on the local machine by running 
-``git tag``. To push the tags to the remote server and trigger the release
-workflow, you can run ``git push origin <tagname>``.
-
-For code quality, please run isort and black before committing (note that the
-latest release of isort may not work through VSCode's integrated terminal, and
-it's safest to run it separately through another terminal).
+Each one bumps the version with ``uv version``, commits ``pyproject.toml`` and
+``uv.lock``, tags ``vX.Y.Z``, and pushes the commit and tag. The tag triggers
+the release workflow, which runs the test suite, builds and checks the package,
+publishes it to PyPI, and creates the GitHub release with the changelog as its
+notes (marked as a pre-release for a candidate). pip installs a candidate only
+when asked, with ``pip install --pre pyrolab`` or ``pip install
+pyrolab==0.5.0rc1``, so everyone else keeps getting the latest release.
+
+``make release`` only works on a candidate. While a candidate is out, ``make
+patch``, ``make minor``, or ``make major`` can only move it up a level (for
+example, if 0.5.1rc1 turns out to need a minor release, ``make minor`` gives
+0.6.0rc1; rename the changelog to match). The rules are in
+``scripts/release.sh``.
+
+Publishing uses PyPI's
+[Trusted Publishing](https://docs.pypi.org/trusted-publishers/): PyPI accepts
+uploads only from this repository's ``release.yml`` workflow running in the
+``pypi`` environment, so no PyPI token is stored in GitHub. Any PR that edits
+``release.yml`` gets a dry run (checks and build, nothing published), and the
+workflow can also be dry-run by hand from the Actions tab.
+
+## Code Quality
+
+Formatting and import sorting use [ruff](https://docs.astral.sh/ruff/), run
+automatically by the pre-commit hooks that ``make install`` sets up. To run it
+by hand, use ``make format``; ``make precommit`` runs every hook on every file,
+as CI does.
 
 ## Building the Docs
 
 Much of the API documentation is autogenerated from the source code. Gitignores
 are in place to prevent you from committing autogenerated pages.
 
-To build the docs, navigate to the ``docs/`` directory and run:
-
-```
-pip install -r requirements.txt
-make html
-```
+To build the docs, run ``make doc`` (which installs the ``docs`` dependency
+group), then ``make serve`` to view them at http://localhost:8000. Read the Docs
+builds them the same way, from ``uv.lock``.
 
 ## Building the Package
 
-You can test the build and view the bundled artifacts using 
-[build](https://pypi.org/project/build/). It's recommended you build locally
+You can test the build and view the bundled artifacts with ``make build``
+(which runs ``uv build``). It's recommended you build locally
 before pushing to PyPI. In particular, double check the included files and make
 sure only the required files are there by modifying MANIFEST.in as necessary.

{pyrolab-0.4.0 → pyrolab-0.5.0rc2}/README.md

@@ -5,7 +5,6 @@
 ---
 
 <p align="center">
-<img alt="Development version" src="https://img.shields.io/badge/master-v0.4.0-informational">
 <a href="https://pypi.python.org/pypi/pyrolab"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/pyrolab.svg"></a>
 <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/pyrolab">
 <a href="https://pyrolab.readthedocs.io/"><img alt="Documentation Status" src="https://readthedocs.org/projects/pyrolab/badge/?version=latest"></a>
@@ -43,7 +42,7 @@ PyroLab declares several "extras", depending on which instruments you need
 to support:
 
 ```
-pip install pyrolab[tsl550, oscope]
+pip install "pyrolab[tsl550,rto]"
 ```
 
 The full list of supported extras is:
@@ -51,18 +50,24 @@ The full list of supported extras is:
 - ``ppcl55x`` (PurePhotonics lasers)
 - ``rto`` (Rohde & Schwarz oscilloscopes)
 - ``arduino`` (Arduino)
-- ``test`` (PyroLab unit testing)
+- ``cameras`` (ThorCam and AmScope cameras, via OpenCV)
 <!-- - ``thorlabs`` (ThorLabs motion controllers) -->
 <!-- - ``adiscovery`` (Analog Discovery boards from Digilent) -->
 <!-- - ``monitor`` (PyroMonitor web application) -->
 
 You can also clone the repository, navigate to the toplevel, and install in 
-editable mode (make sure you have pip >= 21.1):
+editable mode:
 
 ```
 pip install -e .
 ```
 
+For development, use [uv](https://docs.astral.sh/uv/). From the toplevel,
+``make install`` (equivalent to ``uv sync --all-extras`` followed by
+``uv run pre-commit install``) creates a ``.venv`` with PyroLab, every extra,
+and the development tools, and installs the pre-commit hooks. Run tests with
+``make test`` (or ``uv run pytest``).
+
 ## Web Monitor
 
 There's a web application that can monitor your PyroLab nameserver and 
@@ -106,6 +111,7 @@ Run a nameserver:
 
 ```python
 from pyrolab.api import start_ns_loop
+
 start_ns_loop()
 ```
 
@@ -177,48 +183,61 @@ arrays, matplotlib plot objects, custom objects, etc.).
 
 ## Releasing
 
-Make sure you have committed a changelog file under ``docs/changelog`` titled 
-``<major>.<minor>.<patch>-changelog.md`` before bumping version. Also, the git
-directory should be clean (no uncommitted changes).
+The version lives only in ``pyproject.toml``; ``pyrolab.__version__`` reads it
+from the installed package's metadata.
 
-To bump version prior to a release, run one of the following commands:
+Every release starts as a release candidate on PyPI, so what gets tested is
+exactly what gets released. First commit a changelog file under
+``docs/changelog`` titled ``<major>.<minor>.<patch>-changelog.md`` for the new
+version; it becomes the release notes for the candidates and the release. Then,
+with a clean working tree:
 
 ```
-bumpversion major
-bumpversion minor
-bumpversion patch
+make minor      # start a candidate: 0.4.0 -> 0.5.0rc1 (or make patch, make major)
+make rc         # if you need another: 0.5.0rc1 -> 0.5.0rc2
+make release    # release the candidate: 0.5.0rc2 -> 0.5.0
 ```
 
-This will automatically create a git tag in the repository with the 
-corrresponding version number and commit the modified files (where version
-numbers were updated). Pushing the tags (a manual process) to the remote will 
-automatically create a new release. Releases are automatically published to 
-PyPI and GitHub when git tags matching the "v*" pattern are created 
-(e.g. "v0.4.0"), as bumpversion does.
+Each one bumps the version with ``uv version``, commits ``pyproject.toml`` and
+``uv.lock``, tags ``vX.Y.Z``, and pushes the commit and tag. The tag triggers
+the release workflow, which runs the test suite, builds and checks the package,
+publishes it to PyPI, and creates the GitHub release with the changelog as its
+notes (marked as a pre-release for a candidate). pip installs a candidate only
+when asked, with ``pip install --pre pyrolab`` or ``pip install
+pyrolab==0.5.0rc1``, so everyone else keeps getting the latest release.
+
+``make release`` only works on a candidate. While a candidate is out, ``make
+patch``, ``make minor``, or ``make major`` can only move it up a level (for
+example, if 0.5.1rc1 turns out to need a minor release, ``make minor`` gives
+0.6.0rc1; rename the changelog to match). The rules are in
+``scripts/release.sh``.
+
+Publishing uses PyPI's
+[Trusted Publishing](https://docs.pypi.org/trusted-publishers/): PyPI accepts
+uploads only from this repository's ``release.yml`` workflow running in the
+``pypi`` environment, so no PyPI token is stored in GitHub. Any PR that edits
+``release.yml`` gets a dry run (checks and build, nothing published), and the
+workflow can also be dry-run by hand from the Actions tab.
 
-After bumping version, you can view the tags on the local machine by running 
-``git tag``. To push the tags to the remote server and trigger the release
-workflow, you can run ``git push origin <tagname>``.
+## Code Quality
 
-For code quality, please run isort and black before committing (note that the
-latest release of isort may not work through VSCode's integrated terminal, and
-it's safest to run it separately through another terminal).
+Formatting and import sorting use [ruff](https://docs.astral.sh/ruff/), run
+automatically by the pre-commit hooks that ``make install`` sets up. To run it
+by hand, use ``make format``; ``make precommit`` runs every hook on every file,
+as CI does.
 
 ## Building the Docs
 
 Much of the API documentation is autogenerated from the source code. Gitignores
 are in place to prevent you from committing autogenerated pages.
 
-To build the docs, navigate to the ``docs/`` directory and run:
-
-```
-pip install -r requirements.txt
-make html
-```
+To build the docs, run ``make doc`` (which installs the ``docs`` dependency
+group), then ``make serve`` to view them at http://localhost:8000. Read the Docs
+builds them the same way, from ``uv.lock``.
 
 ## Building the Package
 
-You can test the build and view the bundled artifacts using 
-[build](https://pypi.org/project/build/). It's recommended you build locally
+You can test the build and view the bundled artifacts with ``make build``
+(which runs ``uv build``). It's recommended you build locally
 before pushing to PyPI. In particular, double check the included files and make
 sure only the required files are there by modifying MANIFEST.in as necessary.

{pyrolab-0.4.0 → pyrolab-0.5.0rc2}/pyproject.toml

@@ -1,9 +1,9 @@
 [project]
 name = "pyrolab"
-version = "0.4.0"
+version = "0.5.0rc2"
 description = "A framework for using remote lab instruments as local resources built on Pyro5."
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.11"
 license = {text = "GPL-3.0+"}
 keywords = [
   "PyroLab", 
@@ -47,11 +47,10 @@ classifiers = [
   "Topic :: Scientific/Engineering",
   "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.9",
-  "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Programming Language :: Python :: 3 :: Only",
   "Operating System :: MacOS",
   "Operating System :: Microsoft :: Windows",
@@ -63,7 +62,7 @@ dependencies = [
   "numpy",
   "scipy",
   "Pyro5",
-  "pydantic >= 1.9.1, < 2.0.0",
+  "pydantic>=2.8,<3",
   "pyyaml",
   "deprecation",
   "typer",
@@ -71,38 +70,35 @@ dependencies = [
   "tabulate",
   "requests",
   "packaging>=23.0",
+  "platformdirs>=3.0",
 ]
 
-# List additional groups of dependencies here (e.g. development
-# dependencies). Users will be able to install these using the "extras"
-# syntax, for example:
+# Optional hardware dependencies, installed with the "extras" syntax, e.g.
 #
-#   $ pip install sampleproject[dev]
+#   $ pip install pyrolab[arduino]
 [project.optional-dependencies]
 tsl550 = ["pyserial"]
 ppcl55x = ["pyserial"]
 # thorlabs = ["thorlabs_kinesis@git+https://github.com/BYUCamachoLab/thorlabs-kinesis"]
 rto = ["pyvisa", "pyvisa-py"]
 arduino = ["pyfirmata"]
+cameras = ["opencv-python"]
 # adiscovery = ["WF_SDK@git+https://github.com/Digilent/WaveForms-SDK-Getting-Started-PY#egg=WF_SDK"]
 # monitor = ["pyromonitor@git+https://github.com/BYUCamachoLab/pyromonitor"]
-test = ["pytest", "coverage"]
+
+# Development-only dependencies; not published. `uv sync` installs "dev" by
+# default; add `--group docs` for the documentation toolchain.
+[dependency-groups]
 dev = [
-  "notebook",
-  "pytest",
-  "mypy",
   "coverage",
-  "flake8 >= 4.0.1",
-  "isort >= 5.10.1",
-  "black >= 22.1.0",
-  "autopep8 >= 1.6.0",
-  "twine >= 4.0.0",
-  "build >= 0.10.0",
+  "mypy",
   "pre-commit",
-  "bump2version ~= 1.0.1",
+  "pytest",
+  "ruff==0.16.10",  # keep in step with .pre-commit-config.yaml
 ]
 docs = [
   "jupyter-book == 1.0.3",
+  "notebook",
   "numpydoc==1.5.0",
 ]
 
@@ -118,7 +114,7 @@ namespaces = false
 "Research Group" = "https://camacholab.byu.edu/"
 
 [project.scripts]
-pyrolab = "pyrolab.cli:app"
+pyrolab = "pyrolab.cli:run"
 
 [tool.pytest.ini_options]
 minversion = "6.0"
@@ -126,27 +122,35 @@ addopts = "--maxfail=2 -rf"
 testpaths = ["tests"]
 console_output_style = "progress"
 filterwarnings = ["ignore::UserWarning", "ignore::DeprecationWarning"]
+# A test running longer than this dumps every thread's traceback to stderr,
+# so a hang shows where it is stuck instead of silently running until CI's
+# job timeout.
+faulthandler_timeout = 60
+markers = [
+  "hardware: needs physical lab instruments; skipped unless --run-hardware is given",
+]
+
+[tool.coverage.run]
+source = ["pyrolab"]
+
+[tool.coverage.report]
+skip_empty = true
 
 [build-system]
 requires = ["setuptools>=62.0.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
-[tool.isort]
-profile = "black"
-extend_skip_glob = "api.py"
-multi_line_output = 3
-include_trailing_comma = true
-force_grid_wrap = 0
-use_parentheses = true
-line_length = 88
-known_third_party = [
-    "Pyro5",
-    "matplotlib",
-    "numpy",
-    "pytest",
-    "scipy",
-    "setuptools",
-    "typer",
-    "tabulate",
-]
-known_first_party = ["pyrolab"]
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+# Import sorting only, replacing isort. Ruff's default rule set is not
+# enabled yet.
+select = ["I"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["pyrolab"]
+
+[tool.ruff.lint.per-file-ignores]
+# Import order in api.py is load-bearing.
+"pyrolab/api.py" = ["I"]

pyrolab-0.5.0rc2/pyrolab/__init__.py

@@ -0,0 +1,90 @@
+# Copyright © 2020- PyroLab Project Contributors and others (see AUTHORS.txt).
+# The resources, libraries, and some source files under other terms (see NOTICE.txt).
+#
+# This file is part of PyroLab.
+#
+# PyroLab is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# PyroLab is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with PyroLab. If not, see <https://www.gnu.org/licenses/>.
+
+"""
+PyroLab
+=======
+
+A framework for using remote lab instruments as local resources built on Pyro5.
+"""
+
+import logging
+import os
+import platform
+import sys
+
+# Check if Python version is supported
+pyversion = sys.version_info
+if pyversion < (3, 11, 0):
+    raise Exception(
+        "PyroLab requires Python 3.11+ (version "
+        + platform.python_version()
+        + " detected)."
+    )
+
+
+# Metadata
+__title__ = "PyroLab"
+__author__ = "CamachoLab"
+__copyright__ = "Copyright 2020, The PyroLab Project"
+# pyproject.toml is the single source of the version (see `uv version`).
+import importlib.metadata as _metadata
+
+try:
+    __version__ = _metadata.version("pyrolab")
+except _metadata.PackageNotFoundError:  # source tree that isn't installed
+    __version__ = "0.0.0+unknown"
+__license__ = "GPLv3+"
+__maintainer__ = "Sequoia Ploeg"
+__maintainer_email__ = "sequoia.ploeg@byu.edu"
+__status__ = "Development"  # "Production"
+__project_url__ = "https://github.com/sequoiap/pyrolab"
+__forum_url__ = "https://github.com/sequoiap/pyrolab/issues"
+__website_url__ = "https://camacholab.byu.edu/"
+
+
+# Where PyroLab keeps its files: per-user directories (see pyrolab.locations).
+# Importing creates nothing; files and directories are created when written.
+from pathlib import Path
+
+from pyrolab.locations import LEGACY_DATA_DIR
+from pyrolab.locations import locations as _find_locations
+
+_locations = _find_locations()
+
+PYROLAB_DATA_DIR = _locations.data_dir
+NAMESERVER_STORAGE = _locations.data_dir / "nameserver"
+PYROLAB_LOGDIR = _locations.log_dir
+# The daemon's single log file; PYROLAB_LOGFILE overrides where it goes.
+PYROLAB_LOGFILE = Path(
+    os.environ.get("PYROLAB_LOGFILE") or PYROLAB_LOGDIR / "pyrolab.log"
+)
+USER_CONFIG_FILE = _locations.config_dir / "user_configuration.yaml"
+LOCKFILE = _locations.state_dir / "pyrolabd.lock"
+RUNTIME_CONFIG = _locations.state_dir / "runtime_config.yaml"
+# Why the background daemon exited before it could serve requests, for `up`.
+STARTUP_ERROR_FILE = _locations.state_dir / "pyrolabd_startup_error.txt"
+# Records that files from a pre-0.5 install were copied (see pyrolab.locations).
+LEGACY_MIGRATION_MARKER = _locations.state_dir / "legacy_files_copied.txt"
+UPDATE_CHECK_FILE = _locations.cache_dir / "update_check.json"
+
+
+# As a library, PyroLab leaves logging to the application: its loggers do
+# nothing until the application (or PyroLab's own CLI and daemon, see
+# pyrolab.logs) configures logging.
+logging.getLogger(__name__).addHandler(logging.NullHandler())

{pyrolab-0.4.0 → pyrolab-0.5.0rc2}/pyrolab/api.py

@@ -48,7 +48,19 @@ __all__ = [
 
 # If a user config file exists, load the first listed nameserver by default,
 # so that locate_ns "just works."
+# This is a convenience only: importing the API must never fail because the
+# local configuration is invalid, has no nameservers, or names a "public"
+# host that can't be resolved -- otherwise neither client scripts nor the
+# CLI commands that would fix the configuration could even start.
 if USER_CONFIG_FILE.exists():
-    cfg = PyroLabConfiguration.from_file(USER_CONFIG_FILE)
-    nscfg = next(iter(cfg.nameservers.values()))
-    nscfg.update_pyro_config()
+    try:
+        cfg = PyroLabConfiguration.from_file(USER_CONFIG_FILE)
+        nscfg = next(iter(cfg.nameservers.values()), None)
+        if nscfg is not None:
+            nscfg.update_pyro_config()
+    except Exception as e:
+        import logging
+
+        logging.getLogger(__name__).warning(
+            "Not applying nameserver defaults from %s: %s", USER_CONFIG_FILE, e
+        )