eikobot 0.2.1

The eikobot desired state engine.

Eikobot Desired State Engine

The little Desired State Engine that made it so.

Eikobot is a desired state orchestrator.
The basic idea is that you describe your infrastructure and eikobot will make it happen.

The language is akin to python, as this is a commonly used language and the language in which eikobot and eikobot plugins are written.

Installation

Eikobot requires python 3.10 or up and has 2 external dependencies that can be install using pip.
In fact, Eikobot can be installed using pip as well.

Here is an example of how to install Eikobot:
(This should work on most platforms, although the python command might be different if you are on windows)

python3.10 -m venv eikobot-venv
eikobot-venv/bin/pip install eikobot

You can now use the eikobot commands, either by invoking them directly with their venv path:

eikobot-venv/bin/eikobot

Or by activating the venv first:

. eikobot-venv/bin/activate
eikobot

Once you have installed Eikobot, you can get familiar with Eikobot language by reading the basic instructions

Roadmap

Frontend

Features and bug fixes:

• basic lexer
• basic expression parser
• basic types (bool, int, float, string)
• Math and string operations
• Resource definitions
• base import system (import some_module)
• basic typing (allowing expressions for typing)
• cli commands
• add from imports (from some_module import some_thing)
• a plugin system
• add typedefs
• allow for complex types (Type parsing is wholy seperate now)
• add a None type
• add Optional, allowing for something to be either None or some other type.
• allow for NotSet
• add a Union type
• add a List type
• add a Dict type
• automatic/lazy sub imports
• add decorators
• indexes used to track items
• constructors for builtin types
• Path type, uses python Pathlib.Path underneath
• link handlers to resources
• custom constructors
• inheritance for resource
• add Tuple data type and automatic unpacking of tuples
• add for keyword, to loop over lists and dicts
• Expand type system (take module in to account)

Code cleanup:

• Implement an expects function for parser, raise if token is not correct type

STD

• add basic regex.match
• add debug_msg (requires None)
• add IPv4/IPv6 types
• File module
• Templates using jinja

Backend

• add CRUDHandlers and HandlerContext, that reflect how a resource is deployed
• add deployment engine

Linters, type checkers, testing, etc

Currently this project uses:

• mypy for advanced type checking
• isort to auto format the imports
• black to auto format code
• flake8 to do basic linting (and pointing out where isort and black would make changes)
• pylint for advanced linting and code smell detection
• bandit to scan for security issues

Note that the flake8-isort and flake8-black plugins are used, and Flake8 will emit isort and black issues but not auto format them, these tools will still need to be ran afterwards to fix any errors.
The Flake8-pylint and Flake8-mypy plugins are not used as they are in broken state.

For vscode, adding the following settings to your config is recommended:

{
    "python.linting.flake8Enabled": true,
    "python.linting.mypyEnabled": true,
    "python.linting.pylintEnabled": true,
    "python.testing.pytestEnabled": true,
    "python.testing.pytestArgs": [],
    "editor.insertSpaces": true,
}