Happi

This is a maintenance-only/build release. There are no changes to the library code.

What's Changed
* BLD: set content type for readme by klauer in https://github.com/pcdshub/happi/pull/306
* CI: inherit secrets by klauer in https://github.com/pcdshub/happi/pull/307


**Full Changelog**: https://github.com/pcdshub/happi/compare/v2.1.0...v2.1.1

Features
--------
- Adds ``happi repair`` command, for synchronizing backend database with fields expected by container.
Adds a corresponding audit function.
- Adds audit functions that check the connection status of all signals in an
ophyd device (``check_wait_connection``) and verify any fields requested by
args/kwargs exist in the database (``check_args_kwargs_match``).
- Adds ``happi audit -d/--details`` option to print the source of a requested
audit function.
- Adds the ``happi delete`` CLI tool for deleting entries from the happi database.

Bugfixes
--------
- Fix an issue where an ill-timed interrupt of the json backend's
``store`` operation could truncate the data file. This also removes
the implicit/optional dependency on ``fcntl``.

Maintenance
-----------
- Migrates from Travis CI to GitHub Actions for continuous integration testing, and documentation deployment.
- Updates happi to use setuptools-scm, replacing versioneer, as its version-string management tool of choice.
- Syntax has been updated to Python 3.9+ via ``pyupgrade``.
- happi has migrated to modern ``pyproject.toml``, replacing ``setup.py``.
- Sphinx 6.0 now supported for documentation building.

Contributors
------------
- tangkong
- zllentz

API Changes
-----------
- Removed deprecated ``happi.containers.Device`` container.
- Removed deprecated methods:
* ``happi.Client.create_device``
* ``happi.Client.add_device``
* ``happi.Client.find_device``
* ``happi.Client.all_devices``
* ``happi.Client.remove_device``
* ``happi.SearchResult.device``

Features
--------
- Added ``EntryInfo`` keyword argument ``include_default_as_kwarg``. If set to ``False``,
any keys that are included in an item's ``kwargs`` that match the default of their
corresponding ``EntryInfo`` will be omitted from the keyword arguments passed to
``device_class`` when instantiating (loading) the item as in ``happi.loader.load_device`` or
``SearchResult.get()``.
If the ``kwargs`` EntryInfo sets ``include_default_as_kwarg = True``,
the setting on the corresponding ``EntryInfo`` will be used to decide
whether or not to omit a keyword argument.
If the ``kwargs`` EntryInfo sets ``include_default_as_kwarg = False``,
the setting on corresponding ``EntryInfo`` will be ignored.
The default value is True on all EntryInfo instances, retaining the original behavior.
- For happi load, fall back to Python REPL if IPython is not available.
- Added MultiBackend, which allows a happi Client to serve information
from multiple databases simultaneously. Updates config parsing logic
to match.
- Added ``happi audit`` function for running checks on happi database items.
- Restored --json option for ``happi search``.

Bugfixes
--------
- Removed extraneous extraneous print in ``happi load``.
- Calculate a max width for shown tables based on the current terminal size
to prevent bad line wrapping.

Maintenance
-----------
- Prevent ophyd / pyepics teardown during test suite.
- Improved error logging in happi CLI to be more consistent.

Contributors
------------
- JJL772
- klauer
- tangkong


**Full Changelog**: https://github.com/pcdshub/happi/compare/v1.14.0...v2.0.0

API Changes
-----------
- Added ``happi.Client.create_item`` and deprecated ``happi.Client.create_device``.
- Added ``happi.Client.add_item`` and deprecated ``happi.Client.add_device``.
- Added ``happi.Client.find_item`` and deprecated ``happi.Client.find_device``.
- Added ``happi.Client.all_items`` and deprecated ``happi.Client.all_devices``.
- Added ``happi.Client.remove_item`` and deprecated ``happi.Client.remove_device``.
- Deprecated ``happi.SearchResult.device`` and above deprecated items are now scheduled for removal in the next major happi release.
- Internal backend API ``all_devices`` has been changed to ``all_items``.
- Added ``happi.Client.retain_cache_context`` for clients that desire to control when reloading the database from a happi backend happens.
- Backend implementations may now optionally support a caching mechanism with ``clear_cache`` being called externally by the client when desirable.
- The happi container registry now supports adding new container classes manually by way of ``happi.containers.registry["ContainerName"] = ContainerClass``.

Features
--------
- Significant performance increase for JSON-backed happi clients.
- Makes ``SearchResult`` hashable
- Uses hashable ``SearchResult`` in happi search cli command
- JSON database paths may now be relative to the configuration file.
- Added ``happi benchmark`` for identifying which items are slow to load.
- Added ``happi profile`` for identifying why particular items are slow to load.

Bugfixes
--------
- Fix a rare race condition related to reading a json device database twice in a command line search command between database updates.
- Issue where happi Client would repeatedly (and unnecessarily) make database backend calls has been fixed.
- Allow int search values to match their float counterparts
- The happi container registry is loaded at first use and not on import. This can result in increased performance where the happi database is not used. It also fixes a scenario in which a module that defines a happi container attempts to import certain classes from happi.

Maintenance
-----------
- Old terminology for ``HappiItem`` instances has been scrubbed and clarified in documentation.
- Test suite and documentation has been updated to reflect trajectory of deprecated methods and naming.
- Added relaxed flake8 configuration.
- Remove happi.device.Device from tests to avoid deprecation warnings
- Add type annotations to test suite
- Clean up fixture usage and separate ``three_valves`` fixture into ``three_valves`` and ``client_with_three_valves``
- add pre-release notes scripts
- More documentation about the happi container registry was added.
- Refactored CLI slightly to re-use searching logic.

Contributors
------------
- JJL772
- klauer
- tangkong
- zllentz


**Full Changelog**: https://github.com/pcdshub/happi/compare/v1.13.0...v1.14.0

Features
--------
- Added the ``enforce_doc`` argument to ``EntryInfo``. This lets us explain what the entry info represents and how it is meant to be filled out in more explicit words when it would be helpful to do.
- Added methods to client and cli entry points for changing the container of a happi item. This will walk the user through the process of switching to or between custom containers while making sure we adhere to the defined ``EntryInfo``. Check out ``happi transfer --help`` for command-line usage or ``Client.change_container`` for library usage.
- Added the option to pick between glob and regex searching from the CLI, rather than only allowing glob as in the past. Give ``happi search --regex`` a try and check out ``happi search --help`` for more information.

Fixes
-----
- Fixed an issue where it was previously impossible to input dictionary and list fields using the CLI.
- Fixed handling of numeric values in ``happi search``.
- Fixed range searching logic for multiple range searches in one query.
- Fixed the ambiguity between a search returning no results (exit code 0) and a search being malformed (exit code 1).

Maintenance
-----------
- Refactored the CLI to use ``click`` instead of bare ``argparse``. This implementation is much cleaner and will lead to more advanced CLI features in the future.
- ``psdm_qs_cli`` and ``pymongo`` are no longer required dependencies of ``happi``. These have been reclassified into the ``run_constrained`` portion of the conda recipe bundled in this repository and will also be adjusted on conda-forge.
- Improved usage and cleanup of temporary files when running the happi test suite.
- Restored the automatic documention uploads.
- Added/modified test cases to better cover search behavior.

Contributors
------------
- tangkong

Features
--------
- Add optional per-device load timers to help identify slow-loading devices.

Fixes
-----
- Fixed an issue where missing keys could cause a find match to fail.
- Switch on-import fcntl warning to debug to reduce spam.

Contributors
------------
- klauer