EduLinq Python Utilities
Common utilities used by EduLinq Python projects.
Installation / Requirements
This project requires Python >= 3.9.
The project can be installed from PyPi with:
pip3 install edq-utils
Standard Python requirements are listed in pyproject.toml.
The project and Python dependencies can be installed from source with:
pip3 install .
Configuration System
This project provides a configuration system that supplies options (e.g., username, password) to a command-line interface (CLI) tool.
The configuration system follows a tiered order, allowing options to be specified and overridden from both files and command-line options.
The order that configuration sources are processed should be set by the tool using this library.
A description of each configuration source (and the order they are loaded) is output in the help prompt from the --help flag.
Configuration Sources
In addition to CLI options, the configuration system loads options from JSON files located across multiple directories.
By default, configuration files are named edq-config.json.
This value is customizable, but this document will assume the default is used.
For example, a configuration file containing the user and pass options might look like this:
{
"user": "alice",
"pass": "password123"
}
The table below summarizes the configuration sources provided by this library.
| Source | Description |
|---|---|
| CLI (Implicit) | Loaded from the command line as a flag that is NOT --config. |
| CLI (Explicit) | Loaded from the command line via the --config flag. |
| CLI File | Loaded from one or more explicitly provided configuration files through the CLI. |
| Global | Loaded from a file in a user-specific location, which is platform-dependent. |
| Local | Loaded from a file in the current directory. |
| Project | Loaded from a file in the current or nearest ancestor directory. |
The system produces an error if a configuration file is unreadable (but not missing), or if a CLI-specified file is unreadable or missing.
CLI Configuration
CLI configurations are options specified directly on the command line, these are useful for quick option overrides without editing config files.
Explicit configuration options are passed to the command line using the --config flag in this format <key>=<value>.
The provided values overrides the values from configuration files.
Configuration options are structured as key value pairs and keys cannot contain the "=" character.
All other options specified on the command-line are considered "implicit" options.
Below is an example of specifying a configuration option directly from the CLI:
python3 -m edq.cli.config.list --config user=alice --config pass=password123
CLI-Specified Config Files
CLI config files are options specified on the command line via a file.
These are useful for a common set of options you don’t need every time, such as login credentials for different user.
Any files passed via --config-file will be loaded in the order they appear on the command line.
Options from later files override options from previous files.
Below is an example of a CLI specified configuration paths:
python3 -m edq.cli.config.list --config-file ./edq-config.json --config-file ~/.secrets/edq-config.json
Global Configuration
Global configurations are options that are user specific and stick with the user between projects, these are well suited for options like login credentials.
The global configuration file defaults to <platform-specific user configuration location>/edq-config.json.
The configuration location is chosen according to the XDG standard (implemented by platformdirs).
Below are examples of user-specific configuration file paths for different operating systems:
- Linux --
/home/<user>/.config/edq-config.json - Mac --
/Users/<user>/Library/Application Support/edq-config.json - Windows --
C:\Users\<user>\AppData\Local\edq-config.json
The default global configuration location can be changed by passing a path to --config-global through the command line.
Below is an example command for specifying a global configuration path from the CLI:
python3 -m edq.cli.config.list --config-global ~/.config/custom-config.json
Local Configuration
Local configurations are options that are specific to a directory. These options are generally used for special cases. Users should generally prefer project sources instead of local ones.
Project Configuration
Project configurations are options that are specific to a project or directory, like a project's build directory. Project configuration files are searched in multiple locations, starting with the current directory and moving up to each ancestor. The first file found is used. This source is very useful for setting project-specific options in your project's root.
CLI Config Options
The table below lists common configuration CLI options available for CLI tools using this library.
| CLI Option | Description |
|---|---|
--config-global |
Override the global config file location. |
--config-file |
Load configuration options from a CLI specified file. |
--config |
Provide additional options to a CLI command. |
--help |
Display standard help text and the default global configuration file path for the current platform. |
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file edq_utils-1.0.3.tar.gz.
File metadata
- Download URL: edq_utils-1.0.3.tar.gz
- Upload date:
- Size: 128.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
987f0a4757c87738e485003c0e2b7c0f4f80f4ae63fff6a73945f8d898a559bb
|
|
| MD5 |
c8dfdd5cccb255fc325cb6e5a719ae2d
|
|
| BLAKE2b-256 |
a3f9bb7944cf19ea6ec9eaf4ed092bc1e3622bf047a31c661fa423b76198da05
|
File details
Details for the file edq_utils-1.0.3-py3-none-any.whl.
File metadata
- Download URL: edq_utils-1.0.3-py3-none-any.whl
- Upload date:
- Size: 156.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fd839ad6d2c869048fe5d629c9b2a061d2a6db00152efc8602b91b5045ba9512
|
|
| MD5 |
c8e5c77b1edf881c5e60beefefc618f6
|
|
| BLAKE2b-256 |
81339bb08b98fbd2aef49a0363c6611df63e95bcfc1c386646e162f2762874b3
|
