antoniouaa / krypto Goto Github PK

View Code? Open in Web Editor NEW

4.0 2.0 2.0 489 KB

A python tool that creates issues in your repos based on TODO comments in your code

License: MIT License

Python 97.51% Dockerfile 2.26% Shell 0.23%

python githubapi

krypto's Introduction

Krypto

A neat little sidekick python script to create issues on your repo based on comments left in the code on your behalf

Convert todo comments in your code

# TODO[Enhancement]: Make config file
# Sometimes you might wanna have TODOs in your tests.
# Right now krypto will completely ignore any file with the
# substring "test" in the path. I would want to be able to
# configure this behaviour. Perhaps read from pyproject.toml?`

to GitHub issues on the repository you're working on!

Env Variables

For this to work you need to have a github token in your environment variables. To acquire a token navigate to Developer Settings and generate one.

With the token in hand, simply,

export KRYPTO_TOKEN = <token_here>

$env:KRYPTO_TOKEN = token_here

If you want the token to persist across sessions you need to add it to your .bashrc or $PROFILE.

Usage

Write a TODO

First, create a TODO in the form of a block comment. The TODO must contain a title. Body and labels are optional.

Examples:

Title only, no body or labels
```
# TODO: This is a title
```

Title, body, no labels

# TODO: This is a title
# This is in the TODO body

Title, body and labels

# TODO[Enhancement]: This is a title
# This is in the TODO body

Multiple labels

# TODO[Enhancement, Bug, Documentation]: This is a title

Valid separators include , / # ~ \

To run

Pass the directory to look in for TODOs.

krypto run <path-to-dir>

To perform the collection and parsing of TODOs but not the HTTP request to github, pass the --dry flag to the run command.

krypto run <path-to-dir> --dry

Krypto does not look in tests/ at the moment.

GitHub Action

This action runs Krypto on your code and creates issues on the repo on your behalf.

Inputs

`dir`

Required The path to the directory to scan for TODOs.

Env

`KRYPTO_TOKEN`

Required A personal access token for github to use to authenticate the creation of issues on your repository.

Example usage

uses: antoniouaa/krypto@v2
with:
    dir: "."
env:
    KRYPTO_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Run krypto on the root of the project

Inspired by tsoding/snitch

krypto's People

Contributors

Stargazers

Watchers

Forkers

erikoui trendingtechnology

krypto's Issues

test whether this issue has the correct label

Autogenerated by antoniouaa/krypto

Line: 51 in krypto\github.py

Sample todo title

this should not appear on github

Line: 91 in krypto\github.py

CLI tests failing

Click is just being annoying with the testing

Line: 26 in krypto/__init__.py

Check empty todo body

Autogenerated by antoniouaa/wingman

Line: 43 in wingman\github.py

Check if issue already exists to prevent duplication

If the issue does already exist then update its body with the new body. Lets check if this todo is updated!

Line: 32 in wingman\github.py

Add issue number to TODO in code

It would be useful to have the assigned issue number from github attached to the TODO in code so you can immediately identify the TODOs

Line: 138 in krypto/github.py

When krypto creates an issue and attaches a link to the todo locally, it only considers todos in the master branch. It would be nice to be able to either specify which branch you're on or have krypto automatically figure it out and adjust links.

Line: 19 in krypto/__init__.py

Allow for different standard labels to be attached to the issues

Mayhap I would like to assign a todo certain labels like Enhancement Possible syntax # Enhancement: title here or maybe # TODO[Enhancement]: title here Labels are overwritten right now instead of extended

Line: 18 in krypto\__init__.py

Add functionality for multiline comments in js

Will need to change the parser to deal with the new tokens

Line: 12 in krypto/todo.py

Parsing of title stops at '.' and throws away the rest

How to reproduce:

//TODO: ensure foo.bar works.
// body here

will open an issue with title ensure foo and body body here

Desired behaviour: Title should be ensure foo.bar works.

Possible creation of pre-push git hook

Think about making this into a git script to hook into the pre-push action instead of having to run the script manually Lets try to test this right now. Considering making a github action instead of a messy post-push hook

Line: 1 in krypto\__main__.py

Issues are reopened if they're closed through the website

ATM if a user closes an open issue through the Github GUI but does not remove the TODO from the code and reruns krypto, krypto opens a new issue with the same title and body. Krypto should check if an issue with the same title or number exists on github, whether it is closed or still open and decide whether to post or not.

Line: 35 in krypto\github.py