Web API

Package Maximizer Web API — Flask-based REST API with API-key authentication.

class package_maximizer.web.app.RateLimiter(max_requests=100, window=60.0)

Bases: object

Fixed-window rate limiter keyed by client identity.

Parameters:

• max_requests (int)

• window (float)

__init__(max_requests=100, window=60.0)

Parameters:

• max_requests (int)

• window (float)

Return type:

None

is_allowed(key)

Parameters:

key (str)

Return type:

bool

reset(key)

Parameters:

key (str)

Return type:

None

package_maximizer.web.app.validate_maximize_payload(data)

Validate the JSON body for /api/v1/maximize.

Returns (cleaned_pkgs, conflicts, weights) when valid, or raises a ValueError whose message is client-safe.

Parameters:

data (Any)

Return type:

tuple[list[str], list, dict | None]

package_maximizer.web.app.before_request()

package_maximizer.web.app.after_request(response)

package_maximizer.web.app.require_api_key(f)

Simple API key authentication.

package_maximizer.web.app.health()

Health check endpoint.

Return type:

tuple[dict, int]

package_maximizer.web.app.list_solvers()

List all available solvers.

Return type:

tuple[dict, int]

package_maximizer.web.app.list_parsers()

List all available parsers.

Return type:

tuple[dict, int]

package_maximizer.web.app.list_managers()

List all available package managers (parsers).

Return type:

tuple[dict, int]

package_maximizer.web.app.maximize_post()

Maximize packages from JSON body.

Expected JSON body:

{
    "packages": ["pkg1", "pkg2", "pkg3"],
    "manager": "apt",
    "solver": "greedy",
    "conflicts": [["pkg1", "pkg2"]],
    "depends": [["pkg1", "pkg2"]],
    "weights": {"pkg1": 2.0, "pkg2": 1.5},
    "explain": false
}

Return type:

tuple[dict, int]

package_maximizer.web.app.propose_post()

Propose optimal package set with automatic metadata extraction.

Expected JSON body:

{
    "packages": ["requests", "certifi"],
    "manager": "apt",
    "solver": "greedy",
    "explain": false
}

Return type:

tuple[dict, int]

package_maximizer.web.app.maximize_get()

GET /api/maximize?packages=vim,nano&manager=apt&solver=pulp

Return type:

tuple[dict, int]

package_maximizer.web.app.export_post()

Maximize packages and return the result in JSON/CSV/GraphML.

Body is the same as /api/v1/maximize plus an format field (json | csv | graphml).

Return type:

tuple[dict, int] | tuple[str, int] | tuple[str, int, dict[str, str]]

package_maximizer.web.app.benchmark_post()

Run benchmark on specified solvers.

Return type:

tuple[dict, int]

package_maximizer.web.app.cache_stats()

Get cache statistics.

Return type:

tuple[dict, int]

package_maximizer.web.app.cache_clear()

Clear the cache.

Return type:

tuple[dict, int]

package_maximizer.web.app.analyze_post()

Analyze package conflicts and dependencies.

Expected JSON body:

{
    "packages": ["pkg1", "pkg2"],
    "manager": "apt",
    "solver": "greedy",
    "metadata": false,
    "conflicts": [["pkg1", "pkg2"]],
    "depends": [["pkg1", "dep1"]]
}

Return type:

tuple[dict, int]

package_maximizer.web.app.compare_post()

Compare all available solvers on the given package set.

Expected JSON body:

{
    "packages": ["pkg1", "pkg2"],
    "manager": "apt",
    "metadata": false
}

Return type:

tuple[dict, int]

package_maximizer.web.app.not_found(e)

package_maximizer.web.app.method_not_allowed(e)

package_maximizer.web.app.internal_error(e)

package_maximizer.web.app.openapi_spec()

Machine-readable API description (OpenAPI 3.0 subset).

Return type:

tuple[dict, int]

package_maximizer.web.app.api_docs()

Minimal human-readable API documentation page.

Return type:

tuple[str, int]

package_maximizer.web.app.run_app(host='127.0.0.1', port=5000, debug=False)

Run the Flask application.

Parameters:

• host (str)

• port (int)

• debug (bool)

Return type:

None

package_maximizer.web.app.run(host='127.0.0.1', port=5000, debug=False)

Run the Flask application.

Parameters:

• host (str)

• port (int)

• debug (bool)

Return type:

None