mcyph / setool

A data visualization tool for units!

SETool

A cool visualization webapp for Monash University units!

Report Bug / Request Feature

Table of Contents

1. What is SETools?

   1. Technical details

2. Running it locally

   1. pip requirements
   2. Running SETools

3. Future plans

4. Contributing

5. License

6. Contact

7. Acknowledgements

What is SETools?

SETools is a visualization web app that summarizes unit information and gives you details on how a unit was rated by students visually. Check it out here: https://setool.herokuapp.com/. More information is available on the website.

Technical details

The website is rendered with the use of the Dash library which facilitates data based visualizations natively. All the specific mechanisms are coded in Python with related Dash components.

Getting Started

If you wish to run this app locally, you may follow the instructions below.

Pip requirements

See the requirements.txt file for more information.

Running SETools

1. Clone the repository, and in the webapp_main.py replace the following:

app.run_server(debug=False, port=int(os.environ.get('PORT', 5000)),host='0.0.0.0')

with this:

app.run_server(debug=False, port=5000)

Or alternatively a port of your choice. Run the python file and you should be able to visit http://127.0.0.1:PORT (where PORT is the port you chose) and the app should be up.

Roadmap

Most of the features really just concern web design.

• Dark mode without any add-ons
• Writing javascript callback libraries so the website can be converted to a static site and become hosted on github pages.
• More filters

Contributing

Simply fork the repository, modify it as you please then submit a pull request which will then be merged.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Sai kumar Murali krishnan - LinkedIn - [email protected]

Project Link: https://github.com/Theorvolt/SETool

Acknowledgements

• Thanks to everyone who helped out with the website design and gave feedback!