Initial commit

.gitignore

@@ -0,0 +1,27 @@
+# SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+*~
+*.swp
+*.pyc
+*.egg-info
+.nfs*
+.coverage*
+*.DS_Store
+.envrc
+coverage.xml
+test_results.xml
+junit-coverage.xml
+html/
+build/
+doc/api/
+dist/
+cache/
+.venv/
+_citools/
+_work/
+.mypy_cache/
+.pytest_cache/
+changelog.md
+.pixi/

.gitlab-ci.yml

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+include:
+  - project: software/dev-profile
+    file: /gitlab/pixi.yml

.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+# SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.3
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.10.0
+    hooks:
+    - id: mypy
+      args: [ --install-types, --non-interactive, --no-strict-optional, --ignore-missing-imports ]
+      exclude: '^.*/data/second_config\.py$'
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-ast
+      - id: check-added-large-files
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: check-case-conflict
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: debug-statements
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v3.0.2
+    hooks:
+      - id: reuse
+        exclude: |
+          (?x)(
+              ^.pixi/|
+              ^.pixi.lock|
+              )

.readthedocs.yaml

@@ -0,0 +1,17 @@
+# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <[email protected]>
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

.reuse/dep5

@@ -0,0 +1,10 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: clapper
+Upstream-Contact: Andre Anjos <[email protected]>
+Source: https://gitlab.idiap.ch/software/clapper
+
+Files:
+ pixi.lock
+ tests/data/*
+Copyright: Copyright © 2022 Idiap Research Institute <[email protected]>
+License: BSD-3-Clause

LICENSES/BSD-3-Clause.txt

@@ -0,0 +1,11 @@
+Copyright (c) <year> <owner>.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,21 @@
+<!--
+SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
+
+SPDX-License-Identifier: BSD-3-Clause
+-->
+
+[![latest-docs](https://img.shields.io/badge/docs-latest-orange.svg)](https://clapper.readthedocs.io/en/latest/)
+[![build](https://gitlab.idiap.ch/software/clapper/badges/main/pipeline.svg)](https://gitlab.idiap.ch/software/clapper/commits/main)
+[![coverage](https://gitlab.idiap.ch/software/clapper/badges/main/coverage.svg)](https://www.idiap.ch/software/biosignal/docs/software/clapper/main/coverage/index.html)
+[![repository](https://img.shields.io/badge/gitlab-project-0000c0.svg)](https://gitlab.idiap.ch/software/clapper)
+
+
+# Configuration Support for Python Packages and CLIs
+
+This package provides a way to define command-line-interface (CLI) applications
+such that user options can be stored in Python-based configuration files and
+read-out automatically.  It also provides a rather simple RC (global
+configuration) file support that can be used by modules to read
+application-wide default values.
+
+For installation and usage instructions, check-out our documentation.

doc/api.rst

@@ -0,0 +1,23 @@
+.. SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
+..
+.. SPDX-License-Identifier: BSD-3-Clause
+
+.. _clapper.api:
+
+============
+ Python API
+============
+
+This section includes information for using the Python API of ``clapper``.
+
+
+.. autosummary::
+   :toctree: api
+
+   clapper.rc
+   clapper.config
+   clapper.logging
+   clapper.click
+
+
+.. include:: links.rst