Cloudmarker is a cloud security monitoring framework.

Please follow these steps to setup the development environment:

1. Ensure Python 3 is installed.

   # On macOS
   brew install python
   

2. Clone the project repository.

   git clone https://github.com/cloudmarker/cloudmarker.git
   

3. Create a virtual Python environment for development purpose:

   make venv deps
   

4. Activate the virtual Python environment:

   . ./venv
   

5. In the top-level directory of the project, enter this command.

   python3 -m cloudmarker -c -n
   

   The -c option without any arguments following it ensures that it ignores local configuration files (if any) and runs Cloudmarker with the built-in base configuration only. The built-in base configuration makes it run a mock audit that generates mock data at /tmp/cloudmarker.

   The -n option ensures that Cloudmarker ignores any schedule configured in the built-in base configuration and runs the mock audit right now.

6. Run the unit tests, code coverage, linters, and document generator:

   make test
   make coverage
   make lint
   make docs
   

   To run these four targets in one shot, enter this "shortcut" target:

   make checks
   

   Open htmlcov/index.html with a web browser to view the code coverage report.

   Open docs/_build/html/index.html with a web browser to view the generated documentation.