Metadata-Version: 2.4
Name: sardana-config
Version: 3.7.0
Summary: Sardana configuration system
Author: Sardana developers
License-Expression: LGPL-3.0-or-later
Project-URL: Homepage, http://www.sardana-controls.org
Project-URL: Repository, https://gitlab.com/sardana-org/sardana-config
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: sardana>=3.4
Requires-Dist: ruamel.yaml
Requires-Dist: graphviz
Requires-Dist: click
Requires-Dist: pydantic>=2.0
Requires-Dist: dsconfig>=1.9.0
Requires-Dist: setuptools
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytango-db; extra == "tests"
Dynamic: license-file

# Sardana config

*Sardana config* is a commandline tool for managing Sardana (https://sardana-controls.org) 
configurations. It is based around a YAML file format.

This repo contains a separate "fork" of the configuration tool currently built in to 
Sardana  The idea is to decouple the development of this still rather new tool from the 
rest of Sardana which can move quite slowly.

For documentation, for now you are referred to the main Sardana documentation https://sardana-controls.org/users/configuration/index.html

This project depends on Sardana, and will replace the built in version of
the config tool with its own. So you can run it with the main `sardanactl`
script, e.g.

    $ sardanactl config
    
There is also a separate script called `sardana-config`.


## The `--environment` option

Several subcommands (`load`, `dump`) accept a `--environment` flag that enables
reading and writing MacroServer environment variables.

### Sardana version requirement

The `--environment` option is supported only when `sardana config` is run with
Sardana 3.7 or newer. If you attempt to use `--environment` with an older Sardana installation, the tool will emit a warning and skip the environment path, falling back to the default behavior.

## Running `sardana config` with the right Sardana version

It is  recommended to run `sardana config` using the same Sardana
version as the Sardana instance being configured.


## Future of this repo

This repo is an experiment to see if we can speed up development in the short term. 
There is currently no exact plan for the future, we might keep development here and
merge back into Sardana for each release, or the project may live here and be a
dependency of Sardana long term. Or it may eventually completely merge back into
the Sardana codebase.
