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

Automated stats reporting notebook for campaing managers #3701

Conversation

jarmokivekas
Copy link
Contributor

@jarmokivekas jarmokivekas commented Oct 8, 2020

This PR is an initial action to start development around a user interface for managers to see summarized statistics of TM projects related to a specific campaign. This PR related to issue #3394. That issue should be a good place for a broader picture discussion on this topic.

Ping @ramyaragupathy @russdeffner

This PR has the jupyter notebook used for report automation in the COVID activation.

Tasks:

  • add reporting notebook from covid response
  • remove any hard-coded references to covid (original activation during which the notebook was developed)
  • remove the dependency on the tasking manager client library? git+https://github.com/jarmokivekas/tasking-manager-client-python.git
    • This dependency is a a pip-installable python library I created to make it easier to interact with TM API and the data it returns.
    • The notebook by default automatically installs it so it can be executed in google colab with "run all cells"
    • The source code in that library can freely be added to this repo if wanted, or included inline in the notebook. In any case it is a library I modify as I need for my personal use, so will be compatibility breaking changes in it over time.
  • add a requirements.txt for the notebook

@ramyaragupathy ramyaragupathy marked this pull request as ready for review October 27, 2020 17:17
@jarmokivekas
Copy link
Contributor Author

Had another look through this to complete unfinished tasks.

  • removed duplicated notebook with Google Colab specific features
  • removed some left-over references to covid
  • purged notebook cell outputs
  • added more documentations to the README.md in the notebook's working directory.
  • removed left-over import statement to tasking_mananger_client library (which is unstable, as I only intended it for my personal, and would often break backward compatibility)

@jarmokivekas
Copy link
Contributor Author

The notebook has a fair bir of utility functions implemented in inline in the notebook instead or importing them from a python file. My reasoning here is that the notebooks are ment to be read with cell inputs hidden, so large code cells won't matter, and having all the utility funcitons inlined makes it easy to copy the notebook over to whatever workspace it will be used for during an activations. That is, at least for my own use cases, I would copy the notebook elsewhere to have multiple copies, each for a different activation. The way it is written now makes it not depend on anything in this repository. It's just stored here.

@jarmokivekas
Copy link
Contributor Author

I've started making some work related to the features in this old PR.

Closing this PR as outdated.

The source code related to this project has kept on living as a google colab notebook and recently received some maintenance.
Just so it is archived somewhere in writing (perhaps mostly for my own benefit) I'll leave these links here:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant