The Clark Kent Reporter

A mild-mannered reporter with hidden superpowers for your data science projects.

Version 1.0.0

Created by Graham Waters

Table of Contents

• The Clark Kent Reporter
  • A mild-mannered reporter with hidden superpowers for your data science projects.
• Table of Contents
• Automatic Report Generation with Clark Kent Reporter
• What does The Clark Kent Reporter do?
• How to Get Clark Running
• Installation
• Contributing
• Example Use Case
  • The Files
  • The Steps
• License
• Acknowledgments

Automatic Report Generation with Clark Kent Reporter

Latest Version: 1.0.0

Created by Graham Waters

What does The Clark Kent Reporter do?

This tool converts a traditionally formatted overview (in a readme file) into a populated Jupyter Notebook for data science presentations or findings presentations. It doesn't magically transform your work from a document to a presentation, which will still require the careful work that data scientists and analysts are known for. However, it does make sure you don't have to start from scratch when making an interactive and working notebook out of something that would otherwise take hours manually write everything out again. I realized how many readmes I would be reading if I did it the old-fashioned way.

How to Get Clark Running

We recommend using a virtual environment for this. Don't worry if you've never done that before. We did all the heavy lifting for you by including the code here below. Just copy and paste!

conda create --name clark_kent_reporter python=3.9.6

Now that you have your virtual environment set up, you need to activate it. This is done by running the following command:

conda activate clark_kent_reporter

Then install the requirements:

pip3 install -r requirements.txt

You should be good to go!

Installation

Until we are listed on PyPi you can clone the repo and install locally. I will update this section once we are listed on PyPi.

Contributing

If you would like to contribute to this project, please feel free to fork the repository and submit a pull request. I will review the pull request as soon as I can. We welcome any and all contributions as this is a growing tool.

Example Use Case

Let's say I have a project that generates lorebooks for NovelAI project I can use this this tool to generate my overview notebook for the project as follows:

The Files

1. The readme file for NovelAI Lorebook Generator README.md.
2. The MOCKUP_README.md file in the root directory of this repository.

The Steps

1. Open the readme file in a text editor and copy the text.
2. Then I paste the text into the MOCKUP_README.md file in the root directory of this repository.
3. Then I open Clark Kent Reporter in Visual Studio Code and run the script.
4. The destination and source files are set in the main.py file. You can change them to whatever you want.
5. The script will generate a notebook file in the destination directory. In this case, it will be in the notebooks directory. The file will be named generated_notebook.ipynb. If this is not the case for you, please open an issue and I will look into it.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

I would like to thank the following people for their support and guidance:

1. Superman - for being the inspiration for this project.
2. Clark Kent, who is clearly not superman. Because he is just a mild mannered reporter.