esoi: the Python implementation

One example implementation of the tools that apply ESOI: it checks a repository's structure against its records, runs and records measurements, ranks alternatives, resolves a selection table, builds a review sheet, and scans a public repository for private data. Python 3.11 or later; the core has no dependencies.

Install

pip install "esoi @ git+https://github.com/JoshuaMathias/evolvable-structure.git@<commit>#subdirectory=implementations/python"
pip install "esoi[sheets] @ git+https://github.com/JoshuaMathias/evolvable-structure.git@<commit>#subdirectory=implementations/python"   # with Google Sheets sync

From a checkout: pip install -e implementations/python.

Quick start

from esoi import implementation, solution

@solution("greet-a-person")                  # declare once, where the code is
def greet(name: str) -> str: ...

@implementation("greet-a-person", "plain")
def plain(name: str) -> str:
    return f"Hello, {name}!"

greet("Ada")                                 # call: the project default, from the records
greet("Ada", using="plain")                  # or by name for one call

esoi init                   # scaffold a small example repository that already passes
esoi check                  # every rule; --strict also rejects results recorded on uncommitted code
esoi records sync           # the records follow what the code declares
esoi run greet_a_person --impl plain --record   # measure
esoi leaderboard
esoi select --promote       # promote the winner of the solution's own metric

The full walk through is docs/how-to/apply-with-tools.md.

Modules

Reference: configuration, evaluation components, rules.

Using the table from your code (the advanced layer)

from esoi.runtime.implementation_selection.select import Selector

selector = Selector.from_config(config)      # the table `selection` names; an entry without a "default" takes the records' `selected`
implementation = selector.resolve("greet", overrides={"greet": "loud"})

The decorators above and this table are one set of names; see Declare, call, measure, promote.

Tests

python -m pytest implementations/python/tests          # from the repository root; offline, no network

tests/test_components.py runs this repository's own evaluation components, and tests/test_self.py checks the repository against its own structure.