machine-shop / oss_devkit Goto Github PK

Add Sphinx documentation to the project.

When the user types git hub search something, they should get back a list of PRs and Issues with the mentioned keyword in the title or description.

We probably do not want to download all the PR/Issue descriptions on each run, so let's make it store the data and reload only if that data is older than an hour, or if the user provides the --refresh flag.

I recommend we use the following:

• GitHub API v4 (GraphQL)
• Nikola (static page generator)
• Altair (plots)
• Click (command line library)

Altair is still a very young project, so we may have to switch to Matplotlib or Bokeh if it doesn't satisfy our needs.

Please leave your comments below. Teddy, I'd appreciate your input on how easy it is to use the new GraphQL query interface on GitHub.

Invoked by git hub help

One for the command line tool, one for the analytics dashboard

Using pytest

http://click.pocoo.org/5/

Create a command line interface, using click, called git-hub. Add one feature: to pull down a pull request and add a branch for it.

E.g.

git clone [email protected]:scikit-image/scikit-image
git hub pr 2647

https://developer.github.com/v4/

This should use flake8 to check only the changes made in the PR

I think RTD can upload the docs with each push.