nightingale
Uses a binary insert sort to prioritarise bugs (from github issues) in terms of importance.
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.3%) to scientific vocabulary
Repository
Uses a binary insert sort to prioritarise bugs (from github issues) in terms of importance.
Basic Info
- Host: GitHub
- Owner: kjgarza
- License: mit
- Language: Python
- Default Branch: master
- Size: 590 KB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
- Releases: 1
Metadata Files
README.md
Nightingale - Bug prioritizer
This package utilizes binary insert sort to prioritize bugs from GitHub issues. The goal is to facilitate the task of issue tracking and bug fixing by bringing the most important issues to the forefront.
Prerequisites
To use this tool, you should have Python installed on your machine. This tool is compatible with Python 3.6 and above.
Usage
Generate a list of bugs from GitHub into a CSV file named
issues.csv. This CSV file should contain the names and links of the issues.Run the command-line interface (CLI) tool using the
python -m nightingale.clicommand followed by the appropriate arguments.
Arguments:
- <input>: The path to the CSV file with GitHub issues names and links or URL to GitHub repo issue list.
- -o, --output <output>: (Optional) The path to the output file where the prioritized issues will be stored. If not specified, the output will be printed to the console.
- -v, --verbose: (Optional) Enable verbose output.
```shell
python -m nightingale.cli issues.csv
Which issue is more important?
1. 782 relatedItems is erroring when publicationYear is not supplied bug about 18 days ago
2. 764 REST API does not return optional affiliation properties bug about 1 month ago
Enter 1 or 2:
```
- Answer each prompt that appears with the most importan issue. These prompts will guide the tool in prioritizing the issues.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Owner
- Name: Kristian Garza
- Login: kjgarza
- Kind: user
- Location: Berlin
- Website: http://uk.linkedin.com/in/kjgarza/
- Twitter: kriztean
- Repositories: 29
- Profile: https://github.com/kjgarza
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Garza"
given-names: "Kristian"
orcid: "https://orcid.org/0000-0003-3484-6875"
title: "nightingale"
version: 0.1.0
doi: ""
url: "https://github.com/kjgarza/nightingale"
GitHub Events
Total
Last Year
Dependencies
- Brotli ==1.0.9
- Flask ==1.1.2
- Flask-Compress ==1.7.0
- Jinja2 ==2.11.2
- Mako ==1.1.3
- MarkupSafe ==1.1.1
- Pillow ==7.2.0
- Pygments ==2.6.1
- QtPy ==1.9.0
- Rx ==1.6.1
- Send2Trash ==1.5.0
- Werkzeug ==1.0.1
- altair ==4.1.0
- altair-data-server ==0.4.1
- altair-saver ==0.5.0
- altair-viewer ==0.3.0
- appnope ==0.1.0
- argon2-cffi ==20.1.0
- attrs ==20.1.0
- backcall ==0.2.0
- bleach ==3.1.5
- certifi ==2019.11.28
- cffi ==1.14.2
- chardet ==3.0.4
- chord ==0.0.11
- click ==7.1.2
- cycler ==0.10.0
- dash ==1.16.3
- dash-core-components ==1.12.1
- dash-html-components ==1.1.1
- dash-renderer ==1.8.2
- dash-table ==4.10.1
- decorator ==4.4.2
- defusedxml ==0.6.0
- dfply ==0.3.3
- entrypoints ==0.3
- future ==0.18.2
- gql ==0.1.0
- graphql-core ==2.3.2
- idna ==2.8
- ipykernel ==5.3.4
- ipython ==7.17.0
- ipython-genutils ==0.2.0
- ipywidgets ==7.5.1
- itsdangerous ==1.1.0
- jedi ==0.17.2
- joblib ==0.16.0
- jsonschema ==3.2.0
- jupyter ==1.0.0
- jupyter-client ==6.1.7
- jupyter-console ==6.1.0
- jupyter-core ==4.6.3
- kiwisolver ==1.2.0
- matplotlib ==3.2.1
- mistune ==0.8.4
- nbconvert ==5.6.1
- nbformat ==5.0.7
- notebook ==6.1.3
- numpy ==1.18.1
- packaging ==20.4
- pandas ==1.1.1
- pandocfilters ==1.4.2
- parso ==0.7.1
- pexpect ==4.8.0
- pickleshare ==0.7.5
- plotly ==4.11.0
- portpicker ==1.3.1
- prometheus-client ==0.8.0
- promise ==2.2.1
- prompt-toolkit ==3.0.6
- protobuf ==3.13.0
- ptyprocess ==0.6.0
- pycparser ==2.20
- pyparsing ==2.4.7
- pyrsistent ==0.16.0
- python-dateutil ==2.8.1
- python-igraph ==0.7.1.post6
- pytz ==2020.1
- pyzmq ==19.0.2
- qtconsole ==4.7.6
- requests ==2.22.0
- retrying ==1.3.3
- scikit-learn ==0.23.2
- scipy ==1.5.2
- selenium ==3.141.0
- six ==1.13.0
- sklearn ==0.0
- terminado ==0.8.3
- testpath ==0.4.4
- threadpoolctl ==2.1.0
- toolz ==0.10.0
- tornado ==6.0.4
- traitlets ==4.3.3
- urllib3 ==1.25.7
- uuid ==1.30
- vega-datasets ==0.8.0
- wcwidth ==0.2.5
- webencodings ==0.5.1
- widgetsnbextension ==3.5.1
- wordcloud ==1.7.0
- actions/checkout v2 composite
- citation-file-format/cffconvert-github-action 2.0.0 composite
- actions/checkout v3 composite
- actions/setup-python v3 composite
- requests *