2015-08-15 11:50:01 +00:00
|
|
|
.. figure:: ../wooey-banner.png
|
2015-08-15 11:42:27 +00:00
|
|
|
:alt: Wooey!
|
2015-08-12 17:06:42 +00:00
|
|
|
|
|
|
|
|
Welcome to Wooey's documentation
|
|
|
|
|
================================
|
|
|
|
|
|
|
|
|
|
Wooey is a simple web interface to run command line Python scripts. Think of it as an easy way to get your scripts
|
|
|
|
|
up on the web for routine data analysis, file processing, or anything else.
|
|
|
|
|
|
2015-08-15 11:42:27 +00:00
|
|
|
The project was inspired by how simply and powerfully
|
|
|
|
|
`sandman <https://github.com/jeffknupp/sandman>`__ could expose users to
|
|
|
|
|
a database and by how `Gooey <https://github.com/chriskiehl/Gooey>`__
|
|
|
|
|
turns ArgumentParser-based command-line scripts into WxWidgets GUIs.
|
|
|
|
|
Originally two separate projects (Django-based djangui by `Chris
|
|
|
|
|
Mitchell <https://github.com/Chris7>`__ and Flask-based Wooey by `Martin
|
|
|
|
|
Fitzpatrick <https://github/mfitzp>`__) it has been merged to combine
|
|
|
|
|
our efforts.
|
|
|
|
|
|
|
|
|
|
Both of our tools were based on our needs as data scientists to have a
|
|
|
|
|
system that could:
|
|
|
|
|
|
2015-08-15 11:50:01 +00:00
|
|
|
1. Autodocument workflows for data analysis (simple model saving).
|
|
|
|
|
2. Enable fellow lab members with no command line experience to utilize python scripts.
|
|
|
|
|
3. Enable the easy wrapping of any program in simple python instead of having to use language specific
|
|
|
|
|
to existing tools such as Galaxy.
|
2015-08-12 17:06:42 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2015-08-12 17:17:08 +00:00
|
|
|
Getting Started
|
|
|
|
|
===============
|
2015-08-12 17:06:42 +00:00
|
|
|
|
|
|
|
|
.. toctree::
|
2023-05-21 23:57:55 +00:00
|
|
|
:maxdepth: 3
|
2015-08-12 17:06:42 +00:00
|
|
|
|
|
|
|
|
install
|
2015-08-15 11:42:27 +00:00
|
|
|
configuration
|
2017-12-12 14:12:20 +00:00
|
|
|
running_wooey
|
2015-08-15 11:42:27 +00:00
|
|
|
scripts
|
2023-12-05 14:28:48 +00:00
|
|
|
venv_setup
|
2018-05-20 13:37:35 +00:00
|
|
|
wooey_ui
|
2023-06-22 14:51:40 +00:00
|
|
|
api
|
|
|
|
|
api_keys
|
2018-08-04 19:25:56 +00:00
|
|
|
customizations
|
2015-08-15 11:42:27 +00:00
|
|
|
remote
|
2018-04-02 14:29:09 +00:00
|
|
|
upgrade_help
|
2019-11-30 02:03:34 +00:00
|
|
|
changelog
|
2018-11-11 23:29:58 +00:00
|
|
|
security
|
2015-08-12 17:17:08 +00:00
|
|
|
|
|
|
|
|
|
2023-05-20 14:35:03 +00:00
|
|
|
Contributing
|
|
|
|
|
============
|
2015-08-12 17:06:42 +00:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
2023-05-20 14:35:03 +00:00
|
|
|
dev_setup
|
