No project description provided
Project description
Trello To Audit Report
A way to easily generate a markdown file from a trello board.
Getting Started
Requirements
- git
- You'll know you did it right if you can run
git --version
and you see a response likegit version x.x.x
- You'll know you did it right if you can run
- Python
- You'll know you've installed python right if you can run:
python --version
orpython3 --version
and get an output like:Python x.x.x
- You'll know you've installed python right if you can run:
- pipx
pipx
is different from pip- You may have to close and re-open your terminal
- You'll know you've installed it right if you can run:
pipx --version
and see something likex.x.x.x
Optional
If you want to convert trello -> PDF, you'll also need to install pandoc. Please see this repo for learning how to install and work with pandoc.
You will additionally need the eisvogel.latex
template. You can find more information in the repo linked above.
Installation
There are a few options with how to install.
pipx
We recommend using pipx
as it installs your package into a virtual environment.
pipx install trello_to_audit_report
Then, verify it's installation:
trello_to_audit_report -v
To upgrade to the lastest version, run:
pipx upgrade trello_to_audit_report
You should get an output like x.x.x
pip
Otherwise, you can use pip
.
pip install trello_to_audit_report
From Source
You can install from source.
git clone https://github.com/ChainAccelOrg/trello_to_audit_report
cd trello_to_audit_report
pip install . -e
Quickstart - CSV
- Place all your findings in a list on a trello board, and have one list called
Report
- Export your board to a
.csv
file - Run:
trello_to_audit_report <PATH_TO_YOUR_CSV>
And you'll get a file named output.md
with all your code formatted!
Quickstart - Directly from Trello
To create a report directly from Trello, do the following:
- Create an API Key & Token
- Navigate to trello power ups
- Select "New"
- Fill in some information (you can skip the Iframe connector stuff)
- Then, select the hyperlinked "token" on that page, and "turn on" your token by authenticating it.
- Save the API Key and Token
- Create
TRELLO_API_KEY
andTRELLO_API_TOKEN
environment variables.- Or, you can pass them in as flags if you're unfamiliar with environment variables
- Select your board ID
- Each trello board has an ID, you can find it by looking at the URL of the board you're working with
- Each trello board has an ID, you can find it by looking at the URL of the board you're working with
- Make sure you have the following:
- The list of findings are in a list labeled "report
- Each report has the report written and named
report.md
- Each report has a label of "HIGH", "MEDIUM", "LOW", "QA", or "GAS"
- The list of findings are in a list labeled "report
- Run the following
trello_to_audit_report <BOARD_ID> --api-key <API_KEY> --token <API_TOKEN>
And you should get a markdown output to output.md
!
Quickstart - Advanced
The package can also:
- Generate a PDF
- Add any default text before the file
We have some examples in this repo if you installed from source.
trello_to_audit_report 1AhNmEQE --pdf-output examples/example_pdf.pdf --text-before-file examples/example_text_before.md -o ./examples/example_markdown.md
More Resources
You can then, dump it into pandoc
to generate a PDF. We have a repo that shows you how to do that as well.
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 trello_to_audit_report-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00aa5abb0585a190942ef169f61d70393c2c68ef854257798a5ac57c2ea42059 |
|
MD5 | e2ce86dec84ac7e58dd34ae624bca5ba |
|
BLAKE2b-256 | e05100efbf9dfcdc13b9a6f772557768cc4284d9a5021eda75a218109174b649 |
Hashes for trello_to_audit_report-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 768ad2fe6e742b317144e37dc7d424fb3a98558d28e79b3d5ee0d4b9e8697ebc |
|
MD5 | 343b034109ca465030a35435f9eec6f9 |
|
BLAKE2b-256 | a0ae03bff8d49238a39e2504563ff36b425f41f3e88b2eb41e065b77c059a8bb |