diff --git a/mdakits/MDAnalysis-tui/metadata.yaml b/mdakits/MDAnalysis-tui/metadata.yaml new file mode 100644 index 00000000..b6a41d8c --- /dev/null +++ b/mdakits/MDAnalysis-tui/metadata.yaml @@ -0,0 +1,52 @@ +# Required entries +## str: name of the project (the respository name) +project_name: mda-tui +## List(str): a list of authors (or a link to the authors file) +authors: + - https://github.com/p-j-smith/mda-tui/blob/main/AUTHORS.md +## List(str): a list of maintainers +maintainers: + - p-j-smith +## str: a free form description of the mdakit +description: + Trajectory transformations in your terminal +## List(str): a list of keywords which describe the mdakit +keywords: + - transformations + - TUI +## str: the license the mdakit falls under +license: GPL-2.0-or-later +## str: the link to the project's code +project_home: https://github.com/p-j-smith/mda-tui +## str: the link to the project's documentation +documentation_home: https://p-j-smith.github.io/mda-tui/ +## str: the type of documentation available [UserGuide, API, README] +documentation_type: README + UserGuide + +# Optional entries +## List(str): a list of commands to use when installing the latest +## release of the code. Note: only one installation method can currently +## be defined. We suggest using conda/mamba where possible. +install: + - pip install mda-tui +## List(str): a list of commands to use when installing the mdakit from its +## source code. +src_install: + - pip install git+https://github.com/p-j-smith/mda-tui@main +## str: the package name used to import the mdakit +import_name: mda_tui +## str: a specification for the range of Python versions supported by this MDAKit +python_requires: ">=3.10" +## str: a specification for the range of MDAnalysis versions supported by this MDAKit +mdanalysis_requires: ">=2.0.0" +## List(str): a list of commands to use when attempting to run the MDAKit's tests +run_tests: + - git clone latest + - python -m pip install ".[test]" + - pytest -v ./tests +## str: the development status of the MDAKit +development_status: Alpha +## str: a link to the MDAKit's community (mailing list, github discussions, etc...) +community_home: "https://github.com/p-j-smith/mda-tui/discussions" +## str: a link to the MDAKit's changelog +changelog: "https://github.com/p-j-smith/mda-tui/blob/main/CHANGELOG.md"