Skip to content

Commit 1dc0db4

Browse files
anjossgaist
anjos
authored and
sgaist
committed
Initial commit
0 parents  commit 1dc0db4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+8436
-0
lines changed

‎.gitignore

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
2+
#
3+
# SPDX-License-Identifier: BSD-3-Clause
4+
5+
*~
6+
*.swp
7+
*.pyc
8+
*.egg-info
9+
.nfs*
10+
.coverage*
11+
*.DS_Store
12+
.envrc
13+
coverage.xml
14+
test_results.xml
15+
junit-coverage.xml
16+
html/
17+
build/
18+
doc/api/
19+
dist/
20+
cache/
21+
.venv/
22+
_citools/
23+
_work/
24+
.mypy_cache/
25+
.pytest_cache/
26+
changelog.md
27+
.pixi/

‎.gitlab-ci.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
2+
#
3+
# SPDX-License-Identifier: BSD-3-Clause
4+
5+
include:
6+
- project: software/dev-profile
7+
file: /gitlab/pixi.yml

‎.pre-commit-config.yaml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
2+
#
3+
# SPDX-License-Identifier: BSD-3-Clause
4+
5+
# See https://pre-commit.com for more information
6+
# See https://pre-commit.com/hooks.html for more hooks
7+
repos:
8+
- repo: https://github.com/astral-sh/ruff-pre-commit
9+
rev: v0.4.3
10+
hooks:
11+
- id: ruff
12+
args: [ --fix ]
13+
- id: ruff-format
14+
- repo: https://github.com/pre-commit/mirrors-mypy
15+
rev: v1.10.0
16+
hooks:
17+
- id: mypy
18+
args: [ --install-types, --non-interactive, --no-strict-optional, --ignore-missing-imports ]
19+
exclude: '^.*/data/second_config\.py$'
20+
- repo: https://github.com/pre-commit/pre-commit-hooks
21+
rev: v4.6.0
22+
hooks:
23+
- id: check-ast
24+
- id: check-added-large-files
25+
- id: check-toml
26+
- id: check-yaml
27+
- id: debug-statements
28+
- id: check-case-conflict
29+
- id: trailing-whitespace
30+
- id: end-of-file-fixer
31+
- id: debug-statements
32+
- repo: https://github.com/fsfe/reuse-tool
33+
rev: v3.0.2
34+
hooks:
35+
- id: reuse
36+
exclude: |
37+
(?x)(
38+
^.pixi/|
39+
^.pixi.lock|
40+
)

‎.readthedocs.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <[email protected]>
2+
#
3+
# SPDX-License-Identifier: BSD-3-Clause
4+
5+
version: 2
6+
7+
build:
8+
os: "ubuntu-22.04"
9+
tools:
10+
python: "3.11"
11+
12+
python:
13+
install:
14+
- method: pip
15+
path: .
16+
extra_requirements:
17+
- doc

‎.reuse/dep5

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2+
Upstream-Name: clapper
3+
Upstream-Contact: Andre Anjos <[email protected]>
4+
Source: https://gitlab.idiap.ch/software/clapper
5+
6+
Files:
7+
pixi.lock
8+
tests/data/*
9+
Copyright: Copyright © 2022 Idiap Research Institute <[email protected]>
10+
License: BSD-3-Clause

‎LICENSES/BSD-3-Clause.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Copyright (c) <year> <owner>.
2+
3+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
4+
5+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
6+
7+
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.
8+
9+
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.
10+
11+
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

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

‎doc/api.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
2+
..
3+
.. SPDX-License-Identifier: BSD-3-Clause
4+
5+
.. _clapper.api:
6+
7+
============
8+
Python API
9+
============
10+
11+
This section includes information for using the Python API of ``clapper``.
12+
13+
14+
.. autosummary::
15+
:toctree: api
16+
17+
clapper.rc
18+
clapper.config
19+
clapper.logging
20+
clapper.click
21+
22+
23+
.. include:: links.rst

0 commit comments

Comments
 (0)