pyMetricCli is a collection of scripts and API implementations for generating and playing with metrics.
pyMetricCli requires an adapter file to be supplied by the user. This shall contain the credentials and result-handling logic for the seach results. Please DO NOT commit this file into any public repository as your credentials might be exposed.
An example adapter can be found here.
More information on the deployment and architecture can be found in the doc folder.
git clone https://github.com/NewTec-GmbH/pyMetricCli.git
cd pyMetricCli
pip install .This will also install the latest version of pyJiraCli, pyPolarionCli, and pySupersetCli in your Python environment.
pyMetricCli [-h] -a <adapter_file> [--version] [-v]| Flag | Description |
|---|---|
| --verbose , -v | Print full command details before executing the command. Enables logs of type INFO and WARNING. |
| --version | Import a ticket from a JSON file. |
| --help , -h | Show the help message and exit. |
Example:
pyJiraCli --verbose --adapter_file "examples\adapter\adapter.py"The adapter file must contain the Adapter Class derived from the AdapterInterface, including all the methods and members defined in the interface. It is passed to the tool via the --adapter_file <adapter_file> option.
The ***_config dictionaries must be filled with the user credentials for each service. The output dictionary defines the columns of the table that will be sent to Superset, and this cannot be changed after the first time the script is ran. If you are receiving an Error 422 from Superset, a change in this dictionary may be the reason and you should contact your administrator so resolve the issue.
Check out the Examples in the corresponding folder.
Used 3rd party libraries which are not part of the standard Python package:
- toml - Parsing TOML - MIT License
- pyJiraCli - Interfacing with Jira - BSD-3 License
- pyPolarionCli - Interfacing with Polarion - BSD-3 License
- pySupersetCli - Interfacing with Superset - BSD-3 License
If you have further ideas or you found some bugs, great! Create an issue or if you are able and willing to fix it by yourself, clone the repository and create a pull request.
The whole source code is published under BSD-3-Clause. Consider the different licenses of the used third party libraries too!
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.