The missing tool to extract reports about projects you build on Bitrise
Project description
Bitrise Reports
What
A simple cruncher for numbers derived from builds you run on Bitrise CI. Useful if you are in charge of managing infrastructure capacity related to Bitrise, like detecting/reporting anomalies, evaluating queues impact and so on.
Main features:
- Backed by Bitrise REST API under the hood
- Computes queued, running and total execution times for all builds found in the target time frame
- Breakdown numbers per machine type and also per Workflow
- Supports emulation of consumed Bitrise Velocity credits (for Enterprise customers)
- Report types : CLI (stdout), JSON and Excel spreadsheet
Installing
This tool requires Python, supporting versions 3.8.x and 3.9.x.
Install bitrise-reports
with pip
→ pip install bitrise-reports
Using
Let's say you want analyse numbers for the project my-app
, learning from
builds that ran during February of 2021. You'll firstly need a
Bitrise Personal Access Token for
that. Note you must be a member in the project you want to analyse.
By running
→ bitrise-reports \
--token=$BITRISE_PAT_TOKEN \
--app=my-app \
--starting=2021-02-01 \
--ending=2021-02-28
you should get something like that on your CLI
The complete list of CLI options:
Option | Details | Required |
---|---|---|
token | Personal access token for Bitrise API | Yes |
app | The title of your app in Bitrise | Yes |
starting | Starting date in the target time frame | Yes |
ending | Ending date in the target time frame | Yes |
report | The style of report you want | No |
velocity | Estimate Bitrise Velocity credits consumed | No |
where
starting
andending
follow YYYY-MM-DD conventionreport
accepts stdout (default), json or excelvelocity
is a CLI flag
For instance, if you want an Excel spreadsheet - instead of the fancy Terminal UI from the previous example - and also an estimation of Velocity usage, you can run
→ bitrise-reports \
--token=$BITRISE_PAT_TOKEN \
--app=my-app \
--starting=2021-02-01 \
--ending=2021-02-28 \
--report=excel \
--velocity
and the output file bitrise-metrics.xlsx
will be available in the same folder.
Contributing
If you want to contribute with this project
- Check the contribution guidelines
- Ensure you have Python 3.8.+ installed. I recommend Pyenv for that.
- Ensure you have Poetry installed
- Prepare your environment with Flake8, Black and Bandit
→ make setup
- Code you changes
- Make sure you have a green build
→ make inspect test
- Submit your PR 🔥
Author
- Coded by Ubiratan Soares (follow me on Twitter)
License
The MIT License (MIT)
Copyright (c) 2021 Dotanuki Labs
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bitrise_reports-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4f59b61ec1a25b1ee7887755d1d8ac54e849c21dfa76453f3c4a7473a8ba558 |
|
MD5 | bba46f1f0466e59efd0732c67a54bc21 |
|
BLAKE2b-256 | 89883fbde2cf24051f78472025e386e24f5103600eae6a529e802d5589964097 |