Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a Jupyter Notebook programatically #15

Open
tbonza opened this issue Jul 1, 2019 · 0 comments
Open

Create a Jupyter Notebook programatically #15

tbonza opened this issue Jul 1, 2019 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@tbonza
Copy link
Contributor

tbonza commented Jul 1, 2019

We want to have Okra create a Jupyter notebook programatically for reporting analytics. Use the interface okra/proto/okra_api.proto to generate a mock notebook. Let's use okra/tests/mock_db.py when generating an example notebook for this ticket. The Jupyter notebook should be written to the working directory by default.

The implementation for proto/okra_api.proto is okra/repository_metrics.py. Tests for the proto/okra_api.proto implementation are tests/test_repository_metrics.py

  1. Default behavior creates Jupyter notebook in working directory
okra compute https://github.com/okrahealth/okra.git
  1. Option to create Jupyter notebook in specified directory
okra compute https://github.com/okrahealth/okra.git -d /tmp/
  1. Naming convention for notebook should be
owner_name_hash

where owner is okrahealth, name is okra, and hash is the most recent commit hash so 5;
which would be

okrahealth_okra_5.ipynb

Normally, the commit hash would be something like df9af65674c82fbdf40777857c15aa08275934ba but we're using okra/tests/mock_db.py to implement this feature for the time being

Reference: fperez/ProgrammaticNotebook.ipynb

@tbonza tbonza added the enhancement New feature or request label Jul 1, 2019
@tbonza tbonza added this to the Really basic functionality milestone Jul 1, 2019
treble37 added a commit that referenced this issue Jul 8, 2019
treble37 added a commit that referenced this issue Jul 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants