Package: rate-my-project
Rate my projectTable of ContentsRate my projectOverviewInstallationFrom PyPI (Recommended)From sourcesUsageExploration modeReport modeConfigurationServer configurationFields configurationProject configurationContributionOverviewrate my projectis a tool designed to help analyze and improve the
efficiency of a project and the team working on it. It does this by integrating
with Jira, a popular project management tool from Atlassian, to retrieve data
and statistics about the project's progress and the team's performance.By collecting this data from Jira,rate my projectcan provide an objective
view of the project's status and help identify areas for improvement. This can
include metrics such as how long tasks take to complete, how many tasks are
being completed on time, and how much work is being done by each team member.In addition to analyzing the data,rate my projectalso offers the ability
to produce reports in Confluence, another popular collaboration tool in
Atlassian suite. These reports can help visualize the data collected byrate my projectand communicate it to stakeholders, team members, and other
interested parties.Overall,rate my projectis a useful tool for project managers and team
leaders who want to improve their team's efficiency and effectiveness. By using
data to gain an objective view of the project's progress, they can make
informed decisions and take actions that lead to better outcomes.In developing this tool, it became clear that defining universal metrics
according to the topology of your JIRA projects was a complex task, so it was
essential to be able to provide a simple way of adding your own metrics in the
form of a plugin.InstallationFrom PyPI (Recommended)You can install easily with the following command or insert into your
requirements file :pip install rate-my-projectFrom sourcesIt is recommended to use a virtual environment :python-mvenvvenvTo install the module and the main script, simply do :pipinstall.For the developers, it is useful to install extra tools like :pre-commitpytestcommitizenThese tools can be installed with the following command :pipinstall'.[dev]'The Git hooks can be installed with :pre-commitinstallThe hooks can be run manually at any time :pre-commitrun--all-fileUsageThe full list of arguments supported can be displayed with the following
helper :./rate_my_project-h
Usage:rate_my_project[OPTIONS]COMMAND[ARGS]...Swissknifeformeasuringprojectefficiency.

Options:-v,--verboseEnablesverbosemode.-h,--helpShowthismessageandexit.

Commands:exploreExploreefficiencymetricswithwebinterfacefromCONFIGfile.reportGeneratereportfromCONFIGfile.Exploration modeThe first command is used to create a dynamic dashboard to explore the metrics.
The dashboard is a simple webapp which let the user entered a JQL query and
interact with the results.This mode can be started by executing the following command :./rate_my_projectexploremy_config.yamlThe dashboard will be accessible at :http://127.0.0.1:8050Report modeThe second command is used to create a report on Confluence for every project
in the config file.
The objective of this mode is to automate the reporting after finding the
right query in exploration mode.This mode can be started by executing the following command :./rate_my_projectreportmy_config.yamlConfigurationThe configuration file support 2 formats :YAML format(Recommended format)JSON formatIn the configuration file, there are 4 main sections required :servermetricsfieldsprojectsSome fields could use double quotes to preserve space in their names. The YAML
syntax provides a solution by replacing with simple quote or escaping like
JSON :In Yaml :jql:'project="MYTEST"'In Json :{"jql":"project = \"MY TEST\""}Server configurationTheservernode will configure the URL of the Jira and Confluence server.
The credentials could be defined with environment variables or.envfile.
For the moment, only the username/token authentication is supported.ATLASSIAN_USER=<your login>
ATLASSIAN_TOKEN=<your token>In Yaml :server:jira:"https://my.jira.server.com"confluence:"https://my.confluence.server.com"In Json :{"server":{"jira":"https://my.jira.server.com","confluence":"https://my.confluence.server.com"}}AttributeRequiredDescriptionserver✅Main configuration node for server.jira✅Jira server URL to retrieve tickets information.confluence✅Confluence server URL to publish the report.Metrics configurationThemetricsnode will define the list of metrics to be used to avoid
unnecessary calculations or analysis.In Yaml :metrics:-statusIn Json :{"metrics":["status"]}AttributeRequiredDescriptionmetrics✅Main configuration node for metrics.<metric>✅List of metric name. At least one metric is mandatoryFields configurationThefieldsnode will configure the field name to use since it could be custom
fields.In Yaml :fields:sprint:"customfield_10001"story_points:"customfield_10002"In Json :{"fields":{"sprint":"customfield_10001","story_points":"customfield_10002"}}AttributeRequiredDescriptionfields✅Main configuration node for fields.sprint✅Field to store the current sprint.story_points✅Field to store the estimation in story points of a development.Project configurationTheprojectsnode will provide the configuration for each project.In Yaml :projects:<project name>:jql:"project=TEST"report:space:"SPACE"parent_page:"MyParentPage"workflow:-name:"Backlog"status:-"Backlog"-name:"Inprogress"status:-"Inprogress"-"Inreview"-name:"Done"status:-"Closed"In Json :{"projects":{"<project name>":{"jql":"project = TEST","report":{"space":"SPACE","parent_page":"My Parent Page"},"workflow":[{"name":"Backlog","status":["Backlog"]},{"name":"In progress","status":["In progress","In review"]},{"name":"Done","status":["Closed"]}]}}}AttributeRequiredDescriptionprojects✅Main configuration node for all projects.<project name>✅Must be replaced by the name of the project.This name will be used as a title of the report.jql✅JQLquery to retrieve the list of tickets.report✅Configuration node for all attributes related to report generation.space✅Confluence destination space.parent_page✅Confluence parent page of the report page.workflow✅Configuration node for defining workflow.Report configurationSpecific configuration to publish the report on Confluence.AttributeRequiredDescriptionspace✅Confluence destination space.parent_page✅Confluence parent page of the report page.template❌Path to Jinja2 template used to produce the report page.Workflow configurationThe workflow defines a list of states. Each state permits to map several Jira
state to a "Virtual" state to simplify the metrics charts.AttributeRequiredDescriptionname✅Confluence destination space.status✅Confluence parent page of the report page.start❌Boolean value to define the current state is considered as the start of the work in order to compute metrics.stop❌Boolean value to define the current state is considered as the stop of the work in order to compute metrics.ContributionUnless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, shall be as defined in the Apache-2.0 license
without any additional terms or conditions.SeeCONTRIBUTING.md.