/alogamous

A log anomaly detection framework

Primary LanguagePythonMIT LicenseMIT

alogamous

PyPI - Version PyPI - Python Version


Table of Contents

Installation

pip install alogamous

Development

  1. Open a terminal

  2. Install hatch

    curl -Lo hatch-universal.pkg https://github.com/pypa/hatch/releases/latest/download/hatch-universal.pkg
    sudo installer -pkg ./hatch-universal.pkg -target /
  3. Restart your terminal

    Hatch modifies your system PATH variable, and this won't take effect unless you restart the terminal.

  4. Make sure hatch works

    hatch --version
  5. Clone the repo

    git clone https://github.com/aquanauts/alogamous.git
    cd alogamous
  6. Install pre-commit hooks

    This will make sure certain checks are run when committing code.

    hatch run pre-commit:install
  7. Run the tests

    hatch test
  8. Setup your IDE

    ???

License

alogamous is distributed under the terms of the MIT license.