Package: trello-to-audit-report
Trello To Audit ReportA way to easily generate a markdown file from a trello board.Getting StartedRequirementsgitYou'll know you did it right if you can rungit --versionand you see a response likegit version x.x.xPythonYou'll know you've installed python right if you can run:python --versionorpython3 --versionand get an output like:Python x.x.xpipxpipxis different frompipYou may have to close and re-open your terminalYou'll know you've installed it right if you can run:pipx --versionand see something likex.x.x.xOptionalIf you want to convert trello -> PDF, you'll also need to installpandoc. Please seethis repofor learning how to install and work with pandoc.You will additionally need theeisvogel.latextemplate. You can find more information in the repo linked above.InstallationThere are a few options with how to install.pipxWe recommend usingpipxas it installs your package into a virtual environment.pipx install trello_to_audit_reportThen, verify it's installation:trello_to_audit_report -vTo upgrade to the lastest version, run:pipx upgrade trello_to_audit_reportYou should get an output likex.x.xpipOtherwise, you can usepip.pip install trello_to_audit_reportFrom SourceYou can install from source.git clone https://github.com/ChainAccelOrg/trello_to_audit_report
cd trello_to_audit_report
pip install . -eQuickstart - CSVPlace all your findings in a list on a trello board, and have one list calledReportExport your boardto a.csvfileRun:trello_to_audit_report <PATH_TO_YOUR_CSV>And you'll get a file namedoutput.mdwith all your code formatted!Quickstart - Directly from TrelloTo create a report directly from Trello, do the following:Create anAPI Key & TokenNavigate totrello power upsSelect "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 byauthenticating it.Save the API Key and TokenCreateTRELLO_API_KEYandTRELLO_API_TOKENenvironment variables.Or, you can pass them in as flags if you're unfamiliar with environment variablesSelect your board IDEach trello board has an ID, you can find it by looking at the URL of the board you're working withMake sure you have the following:The list of findings are in a list labeled "reportEach report has the report written and namedreport.md(if you don't have one, it'll just grab the first.mdattachment. If no.md, the first attachment. If no attachment, it will error. )Each report has a label of "HIGH", "MEDIUM", "LOW", "QA", or "GAS"Run the followingtrello_to_audit_report <BOARD_ID> --api-key <API_KEY> --token <API_TOKEN>And you should get a markdown output tooutput.md!Quickstart - AdvancedThe package can also:Generate a PDFAdd any default text before the fileWe have some examples in this repo if youinstalled 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.mdOr, if you have a certain severity like QA in a single ticket, run the following:trello_to_audit_report 1AhNmEQE --pdf-output examples/example_pdf.pdf --text-before-file examples/example_text_before.md -o ./examples/example_markdown.md -e QMore ResourcesYou can then, dump it intopandocto generate a PDF. We havea repothat shows you how to do that as well.