Git Product home page Git Product logo

katti's Introduction

Katti who? πŸš€

Katti is in the development phase. We are continuously working on improving Katti and adding new features. Therefore we will release new versions in regular intervals.

The development of Katti started as a pure crawling framework. In the meantime, Katti not only offers the possibility to automatically load websites and store the data, but also provides the tools to analyze the obtained data. The goal is to develop a scalable platform that allows an easy automated analysis of websites and their infrastructure.

Requirements

  • docker and the docker compose plugin
  • Python >=3.10 (tested on python==3.10)

Instructions to do cool stuff

  1. Clone this repo to ~/katti
  2. Optionally: Create and activate a virtual environment
    • cd katti
    • pip install virtualenv
    • virtualenv venv
    • source venv/bin/activate
  3. Set $PYTHONPATH
    • export PYTHONPATH=~/katti
  4. Install Katti and its dependencies
    • pip install .
  5. Start backbone services (Redis, MongoDB, RabbitMQ) with docker compose
    • docker compose up -d
  6. Execute the Setup Script
    • python katti/SetupKatti
  7. Start the celery workers
    • cd katti/CeleryApps
    • celery -A celery -A KattiApp worker -Q scanning,default,fast_lane --concurrency 6 --loglevel debug

You’re done! Execute the test script ~/katti/test.py to see if it works.

Configuration

See ~/katti/katti_config

  • database_configs.yml, celery.yml: Configure the way Katti talks to the backbone services
  • env.yml: Manage API credentials
  • scanner.yml: Configure default scanners

    You can change the default config paths in ~/katti/katti/KattiUtils/Configs/Paths.py

katti's People

Contributors

florian-work avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.