Flexible Metadata Format
Project description
Flexible Metadata Format
Description
The fmf Python module and command line tool implement a flexible format for defining metadata in plain text files which can be stored close to the source code and structured in a hiearchical way with support for inheritance.
Although the proposal initially originated from user stories centered around test execution, the format is general and thus can be used in broader scenarios, e.g. test coverage mapping.
Using this approach it’s also possible to combine both test execution metadata and test coverage information. Thanks to elasticity and hiearchy it provides ability to organize data into well-sized text documents while preventing duplication.
Synopsis
Command line usage is straightforward:
fmf [path...] [options]
Examples
List all metadata stored in the current directory:
fmf
Show all test metadata (with ‘test’ attribute defined):
fmf --key test
List all attributes for the wget/recursion tests:
fmf --name wget/recursion
See fmf --help for complete list of available options.
Options
Here is the list of the most frequently used options.
Select
Limit which metadata should be listed.
- --key=KEYS
Key content definition (required attributes)
- --name=NAMES
List objects with name matching regular expression
- --filter=FLTRS
Apply advanced filter when selecting objects
- --whole
Consider the whole tree (leaves only by default)
Format
Choose the best format for showing the metadata.
- --brief
Show object names only (no attributes)
- --format=FMT
Output format (now: text, future: json, yaml)
Utils
Various utility options.
- --verbose
Print additional information standard error output
- --debug
Turn on debugging output, do not catch exceptions
See fmf --help for complete list of available options.
Install
Install from the Copr repository:
yum install fmf
or use PIP (sudo required if not in a virtualenv):
pip install fmf
See documentation for more details about installation options.
Links
Git: https://github.com/psss/fmf
Docs: http://fmf.readthedocs.io/
Issues: https://github.com/psss/fmf/issues
Releases: https://github.com/psss/fmf/releases
Copyright
Copyright (c) 2018 Red Hat, Inc.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file fmf-0.1.1-py2-none-any.whl.
File metadata
- Download URL: fmf-0.1.1-py2-none-any.whl
- Upload date:
- Size: 14.5 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e392ef299dc8df5e9368a24e97965624d130be705e460ea080a91b13d35b2a0b |
|
| MD5 | f8f7b2849cee0a5458acffa98ab147b7 |
|
| BLAKE2b-256 | 549b3e156b8c4b5b979b367d2ee735a9576a67da472a1445f5b13ed17d5b8dbd |
