https://github.com/ggonnella/findconfig

Find a config file in XDG config paths, home directory or directories of the calling package
https://github.com/ggonnella/findconfig

Last synced: 17 days ago
JSON representation

Find a config file in XDG config paths, home directory or directories of the calling package

• Host: GitHub
• URL: https://github.com/ggonnella/findconfig
• Owner: ggonnella
• License: other
• Created: 2022-04-30T09:31:31.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T15:51:24.000Z (almost 2 years ago)
• Last Synced: 2024-12-28T09:27:23.674Z (about 1 month ago)
• Language: Python
• Size: 13.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.txt
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# FindConfig

FindConfig is a Python package which implements the simple task

of looking for a configuration file in a series of locations.

## Usage

```

from findconfig import findconfig

config = findconfig("my.config.yaml")

```

The command above returns the Pathlib path of the first file found in the

locations indicated below (in the order), which has the given filename,

with or without a prepended dot (e.g. ``.my.config.yaml`` in the example above).

## Config file locations

The locations which are searched are, in order of priority:

- the directories indicated in the XDG specification:

  - XDG config home

  - XDG config dirs

- the home directory of the user

- the source code directory of the calling program:

  - the directory of the calling module

  - any ancestor directory, stopping at (and including) the first one

    which does not contain a ``__init__.py`` file

- directories listed in the ``more_path`` keyword argument

### Options

The following keyword options can be used:

```

more_path (list of strings or Path, default: []): directory names to be searched

  into, in the order, _after_ the default locations stated above

allow_dot (boolean, default: True): also look for the filename with a prepended

  dot, if the filename does not start with a dot

use_xdg (boolean, default: True): enable searching in the XDG specification paths

use_home (boolean, default: True): enable searching in the user home directory

use_src (boolean, default: True): enable searching in the source code directory

                              of the program

src_climb (int, default: 1): maximum number of ancestor directories to search

                             from the first directory without a __init__.py file

                             starting from the directory containing the calling

                             module

exception (boolean, default: False): raise an exception is the file is not found

                                     (default: return None and do not raise)

verbose (boolean, default: False): print the path of the found configuration

                                   file to the standard error

```

## Acknowledgements

This software has been originally created in context of the DFG project GO 3192/1-1 “Automated characterization of microbial genomes and metagenomes by collection and verification of association rules”. The funders had no role in study design, data collection and analysis.