wec

About

WeatherEye Controller (wec) is a single codebase, implemented using the Python Textualize package, that provides a Command Line Interface (CLI), Text User Interface (TUI) and Web UI for provisioning (Terraform), orchestrating (Ansible) and configuring WeatherEye software on Linux servers.

wec is aware of environments that it can install to including:

1. Provisioning
   • Infrastructure Providers (e.g. Locally Proxmox or VMWare. Remote: Amazon Web Services, Google Cloud Platform etc. see supported providers
2. Orchestrating
   • Linux servers (VMs, cloud instances)
3. Configuration Management
   • WeatherEye Admin Django project (configuring which Django apps are running in a single Django instance)
   • Other WeatherEye application configurations

The wec command line tool includes the following modules which can also be accessed through WeatherEye Admin:

• WeatherEye Upgrade
• WeatherEye Rollback
• WeatherEye Backup

Powered by:

• Terraform for server provisioning
• Ansible for server orchestration
• Textualize (MIT) - An application framework for CLI, TUI and WebUI in a single codebase
• pipx - A way to install Python CLI's as a tool in a contained environment

Tests

Run pytest. For more detailed output, including test coverage:

pytest -vv --cov=. --cov-report term-missing

Contributing

If you would like to contribute to the project:

• if you're making code contributions, please try and write some tests to accompany your code, and ensure that the tests pass.
• commit your changes via cz commit. Follow the prompts. When you're done, pre-commit will be invoked to ensure that your contributions and commits follow defined conventions. See pre-commit-config.yaml for more details.
• your commit messages should follow the conventions described here. Write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug." This convention matches up with commit messages generated by commands like git merge and git revert. Once you are done, please send a merge request.