======================
fmf
======================
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
hierarchical 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 hierarchy it provides ability to organize data
into well-sized text documents while preventing duplication.
Synopsis
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Command line usage is straightforward::
fmf command [options]
There are following commands available::
fmf ls List identifiers of available objects
fmf show Show metadata of available objects
fmf init Initialize a new metadata tree
fmf clean Remove cache directory and its content
Examples
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List names of all objects stored in the metadata tree::
fmf ls
Show all test metadata (with 'test' attribute defined)::
fmf show --key test
Show metadata for all tree nodes (not only leaves)::
fmf show --key test --whole
List all attributes for the ``/recursion`` tests::
fmf show --key test --name /recursion
Show all covered requirements::
fmf show --key requirement --key coverage
Search for all tests with the ``Tier1`` tag defined and show a
brief summary of what was found::
fmf show --key test --filter tags:Tier1 --verbose
Use arbitrary Python expressions to access deeper objects and
create more complex conditions::
fmf show --condition "execute['how'] == 'shell'"
Initialize a new metadata tree in the current directory::
fmf init
Check help message of individual commands for the full 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
--condition=EXPR
Use arbitrary Python expression for filtering
--whole
Consider the whole tree (leaves only by default)
For filtering regular expressions can be used as well. See
``pydoc fmf.filter`` for advanced filtering options.
Format
------
Choose the best format for showing the metadata.
--format=FMT
Custom output format using the {} expansion
--value=VALUES
Values for the custom formatting string
See online documentation for details about custom format.
Utils
-----
Various utility options.
--path PATHS
Path to the metadata tree (default: current directory)
--verbose
Print additional information standard error output
--debug
Turn on debugging output, do not catch exceptions
Check help message of individual commands for the full list of
available options.
Install
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The fmf package is available in Fedora and EPEL::
dnf install fmf
Install the latest version from the Copr repository::
dnf copr enable @teemtee/fmf
dnf install fmf
or use PIP::
pip install fmf
See documentation for more details about installation options.
Variables
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here is the list of environment variables understood by fmf:
FMF_CACHE_DIRECTORY
Directory used to cache git clone calls for fmf identifiers.
Links
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Git:
https://github.com/teemtee/fmf
Docs:
http://fmf.readthedocs.io/
Issues:
https://github.com/teemtee/fmf/issues
Releases:
https://github.com/teemtee/fmf/releases
Copr:
http://copr.fedoraproject.org/coprs/g/teemtee/fmf
PIP:
https://pypi.org/project/fmf/
Authors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Petr Šplíchal, Miro Hrončok, Jakub Krysl, Jan Ščotka, Alois
Mahdal, Cleber Rosa, Miroslav Vadkerti, Lukáš Zachar, František
Nečas, Evgeny Fedin, Pablo Martin, Zhaojuan Guo, Laura Barcziová,
Petr Matyáš and Filip Vágner.
Copyright
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Copyright (c) 2018-2021 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/psss/fmf",
"name": "fmf",
"maintainer": "Petr Splichal",
"docs_url": null,
"requires_python": "",
"maintainer_email": "psplicha@redhat.com",
"keywords": "metadata,testing",
"author": "Petr Splichal",
"author_email": "psplicha@redhat.com",
"download_url": "https://github.com/psss/fmf/archive/master.zip",
"platform": null,
"description": "\n======================\n fmf\n======================\n\nFlexible Metadata Format\n\n\nDescription\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe ``fmf`` Python module and command line tool implement a\nflexible format for defining metadata in plain text files which\ncan be stored close to the source code and structured in a\nhierarchical way with support for inheritance.\n\nAlthough the proposal initially originated from user stories\ncentered around test execution, the format is general and thus\ncan be used in broader scenarios, e.g. test coverage mapping.\n\nUsing this approach it's also possible to combine both test\nexecution metadata and test coverage information. Thanks to\nelasticity and hierarchy it provides ability to organize data\ninto well-sized text documents while preventing duplication.\n\n\nSynopsis\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nCommand line usage is straightforward::\n\n fmf command [options]\n\nThere are following commands available::\n\n fmf ls List identifiers of available objects\n fmf show Show metadata of available objects\n fmf init Initialize a new metadata tree\n fmf clean Remove cache directory and its content\n\n\nExamples\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nList names of all objects stored in the metadata tree::\n\n fmf ls\n\nShow all test metadata (with 'test' attribute defined)::\n\n fmf show --key test\n\nShow metadata for all tree nodes (not only leaves)::\n\n fmf show --key test --whole\n\nList all attributes for the ``/recursion`` tests::\n\n fmf show --key test --name /recursion\n\nShow all covered requirements::\n\n fmf show --key requirement --key coverage\n\nSearch for all tests with the ``Tier1`` tag defined and show a\nbrief summary of what was found::\n\n fmf show --key test --filter tags:Tier1 --verbose\n\nUse arbitrary Python expressions to access deeper objects and\ncreate more complex conditions::\n\n fmf show --condition \"execute['how'] == 'shell'\"\n\nInitialize a new metadata tree in the current directory::\n\n fmf init\n\nCheck help message of individual commands for the full list of\navailable options.\n\n\nOptions\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nHere is the list of the most frequently used options.\n\nSelect\n------\n\nLimit which metadata should be listed.\n\n--key=KEYS\n Key content definition (required attributes)\n\n--name=NAMES\n List objects with name matching regular expression\n\n--filter=FLTRS\n Apply advanced filter when selecting objects\n\n--condition=EXPR\n Use arbitrary Python expression for filtering\n\n--whole\n Consider the whole tree (leaves only by default)\n\nFor filtering regular expressions can be used as well. See\n``pydoc fmf.filter`` for advanced filtering options.\n\nFormat\n------\n\nChoose the best format for showing the metadata.\n\n--format=FMT\n Custom output format using the {} expansion\n\n--value=VALUES\n Values for the custom formatting string\n\nSee online documentation for details about custom format.\n\nUtils\n-----\n\nVarious utility options.\n\n--path PATHS\n Path to the metadata tree (default: current directory)\n\n--verbose\n Print additional information standard error output\n\n--debug\n Turn on debugging output, do not catch exceptions\n\nCheck help message of individual commands for the full list of\navailable options.\n\n\nInstall\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe fmf package is available in Fedora and EPEL::\n\n dnf install fmf\n\nInstall the latest version from the Copr repository::\n\n dnf copr enable @teemtee/fmf\n dnf install fmf\n\nor use PIP::\n\n pip install fmf\n\nSee documentation for more details about installation options.\n\n\nVariables\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nHere is the list of environment variables understood by fmf:\n\nFMF_CACHE_DIRECTORY\n Directory used to cache git clone calls for fmf identifiers.\n\n\nLinks\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nGit:\nhttps://github.com/teemtee/fmf\n\nDocs:\nhttp://fmf.readthedocs.io/\n\nIssues:\nhttps://github.com/teemtee/fmf/issues\n\nReleases:\nhttps://github.com/teemtee/fmf/releases\n\nCopr:\nhttp://copr.fedoraproject.org/coprs/g/teemtee/fmf\n\nPIP:\nhttps://pypi.org/project/fmf/\n\n\nAuthors\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nPetr \u0160pl\u00edchal, Miro Hron\u010dok, Jakub Krysl, Jan \u0160\u010dotka, Alois\nMahdal, Cleber Rosa, Miroslav Vadkerti, Luk\u00e1\u0161 Zachar, Franti\u0161ek\nNe\u010das, Evgeny Fedin, Pablo Martin, Zhaojuan Guo, Laura Barcziov\u00e1,\nPetr Maty\u00e1\u0161 and Filip V\u00e1gner.\n\n\nCopyright\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nCopyright (c) 2018-2021 Red Hat, Inc.\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License as\npublished by the Free Software Foundation; either version 2 of\nthe License, or (at your option) any later version.\n",
"bugtrack_url": null,
"license": "GPLv2",
"summary": "Flexible Metadata Format",
"version": "1.3.0",
"project_urls": {
"Download": "https://github.com/psss/fmf/archive/master.zip",
"Homepage": "https://github.com/psss/fmf"
},
"split_keywords": [
"metadata",
"testing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "72b31d01f4a7e9bc7ec1cf5d79bdfd5b5e4d3f5555943ba551539837c50ad8ef",
"md5": "597b97a4db57c4a1637cd333a4c941a3",
"sha256": "2563b958c32362f3195b47e6698631cc77301b24ecb6ced134d2d652a3d93852"
},
"downloads": -1,
"filename": "fmf-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "597b97a4db57c4a1637cd333a4c941a3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 37570,
"upload_time": "2023-10-02T15:48:42",
"upload_time_iso_8601": "2023-10-02T15:48:42.457840Z",
"url": "https://files.pythonhosted.org/packages/72/b3/1d01f4a7e9bc7ec1cf5d79bdfd5b5e4d3f5555943ba551539837c50ad8ef/fmf-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-02 15:48:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "psss",
"github_project": "fmf",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "fmf"
}
JSON
