intensive brew

Simple cli tool that converts a simple yaml into a compatible Locust Kubernetes Operator custom resource.

Using

To add and install this package as a dependency of your project, run poetry add intensive-brew.

To view this app's commands once it's installed, run intensive-brew --help. Alternatively, you can also use docker compose run --rm app --help.

Contributing

Setup: once per device

1. Install Docker Desktop.
   • Enable Use Docker Compose V2 in Docker Desktop's preferences window.
2. Install Poetry.
3. Install Pre-commit
   • On macOS run: brew install pre-commit

Developing

• Clone repository
• Setup development environment
  • Stage 1: setup IntelliJ to work with the project
    • [prerequisite] Python plugin for IntelliJ from JetBrains.
    • Step 1: in IntelliJ go to File → Project Structure → SDKs → + → Add Python SDK... → Poetry Environment → OK
      • An environment will be instantiated and dependencies will be installed
    • Step 2: Select the created SDK as the SDK for the project
      • File → Project Structure → Project → SDK → SDK with project name
  • Stage 2: from the terminal
    • cd to the repository location
    • Install git pre-commit hooks

      pre-commit install --install-hooks

Documentation

The project uses mkdocs.org to build and maintain its documentation.

• Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

• Project layout

  mkdocs.yml    # The configuration file.
  docs/
    index.md      # The documentation homepage.
    ...           # Other markdown pages, images and other files.
  

General information

• This project follows the Conventional Commits standard to automate Semantic Versioning and Keep A Changelog with Commitizen.
• Run poe from within the development environment to print a list of Poe the Poet tasks available to run on this project.
• Run poetry add {package} from within the development environment to install a run time dependency and add it to pyproject.toml and poetry.lock. Add --group test or --group dev to install a CI or development dependency, respectively.
• Run poetry remove {package} from within the development environment to uninstall a run time dependency and remove it from pyproject.toml and poetry.lock. Add --group test or --group dev to uninstall a CI or development dependency, respectively.
• Run poetry update from within the development environment to upgrade all dependencies to the latest versions allowed by pyproject.toml.
• Run cz bump to bump the package's version, update the CHANGELOG.md, and create a git tag.
• Project has a protection against pushing to main/master branches by utilizing pre-commit hooks.