saberlynx / hyperion

Future GVM Architecture

Project Hyperion

Project Hyperion is the next generation GVM Architecture.

The project is named after the titan Hyperion, the titan of the light. Hyperion is the father of Helios (Sun), Selene (Moon) and Eos (Dawn).

The project is a django project consisting of the django app: Selene.

Selene is the first step of getting a whole new architecture.

Table of Contents

• Table of Contents
• Installation
  • Requirements
  • Development
• Usage
• Maintainer
• License

Installation

Requirements

Hyperion depends on django, graphene and graphene-django for selene.

Selene also requires python-gvm.

Only Python 3.7 and later is supported.

Development

For development, you should use poetry to keep your Python packages separated in different environments. To manage the environments poetry depends on the venv package.

On Debian based systems venv can be installed with

sudo apt install python3-venv

Poetry can be installed via pip. On Debian based systems pip itself can be installed via

sudo apt install python3-pip

To install poetry run

python3 -m pip install --user poetry

Afterwards run in the cloned directory of hyperion

cd /path/to/hyperion
poetry install

to install all dependencies including all dependencies only required for development into a virtual python environment.

For linting and auto formatting of the Python code you should ensure that the autohooks git hooks are activated.

poetry run autohooks activate --force

Usage

A development server can be started via

poetry shell
python manage.py runserver

The development server listens on localhost (127.0.0.1) and port 8000.

Maintainer

This project is maintained by Greenbone Networks GmbH.

License

Copyright (C) 2019 - 2021 Greenbone Networks GmbH

Licensed under the GNU Affero General Public License v3.0 or later.