ToolWatch Status Application
ToolWatch checks the health status of various Wikimedia tools and displays them in a user-friendly UI. More at: https://phabricator.wikimedia.org/T341379
Installation
- Clone the repository:
git clone https://github.com/gopavasanth/ToolWatch
- Navigate to the project directory:
cd ToolWatch
- Create a virtual environment:
python -m venv venv
- Activate the virtual environment:
- For Windows:
venv\Scripts\activate
- For Unix/Linux:
source venv/bin/activate
- For Windows:
- Install the dependencies:
pip install -r requirements.txt
Usage
- Run the Flask app:
python app.py
- Open your web browser and visit
http://localhost:5000
to view the tool health status.
Directory Structure
The directory structure of the project is as follows:
- The
database
directory contains the SQLite database file.- The
templates
directory contains HTML templates. - The
model.py
file defines the Tool model and sets up the database.
- The
- The
app.py
file is the main entry point of the Flask application.
Customization
- To add or modify tools, you can edit the
tools/models.py
file and add or update the Tool model attributes. - For more advanced health checks, you can modify the
tools/views.py
file and implement the logic in thecheck_tool_health()
function.
Contributing
Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request.
License
This project is licensed under the MIT License.