Skip to main content

Documentation PyPI version License

asplain

Asplain is a tool for generating contrastive explanations for answer set programs (ASP).

Installation

To install the project, run

pip install .

For rendering the images with cligraph, Graphviz needs to be installed following graphviz <https://www.graphviz.org/download/>_ (version 2.50 or greater).

Documentation

Full documentation is available at docs.potassco.org/asplain.

Usage

Run the following for basic usage information:

asplain -h

For a basic usage example, see the examples/james-bond/README.md file.

LLM Integration

For using the OpenAI API, an API-Key has to be provided in the OPENAI_API_KEY environment variable. This can be done using a .envfile or directly in the command line.

Using the .env file

Create a .env file in the root directory of the project and add the following line

OPENAI_API_KEY=<your-api-key>

Using the command line

OPENAI_API_KEY=<your-api-key> asplain --llm=<model-tag>

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asplain-1.1.4.tar.gz (928.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

asplain-1.1.4-py3-none-any.whl (50.9 kB view details)

Uploaded Python 3

File details

Details for the file asplain-1.1.4.tar.gz.

File metadata

  • Download URL: asplain-1.1.4.tar.gz
  • Upload date:
  • Size: 928.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for asplain-1.1.4.tar.gz
Algorithm Hash digest
SHA256 163b54c8174b34114a12ba5dc485cf7c771d99f9b864565786d432e41c6064e7
MD5 8134ac447c11da9eea25196d670d5ca4
BLAKE2b-256 cb9a34661df41c8296983fcd831026f3f5149e02b0a37b194e5a988f3fe64bf2

See more details on using hashes here.

Provenance

The following attestation bundles were made for asplain-1.1.4.tar.gz:

Publisher: deploy.yml on potassco/asplain

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file asplain-1.1.4-py3-none-any.whl.

File metadata

  • Download URL: asplain-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 50.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for asplain-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8e53e905271b309cf3b4fa0bea42dc36ffcddec32d2bd3c8b3aee3799293dfbb
MD5 61c8026025490da457d9230e7d2423cc
BLAKE2b-256 4e4b38c3d46a5c72832e26cef1a15af113bd31728817b0f8f47c87059223565c

See more details on using hashes here.

Provenance

The following attestation bundles were made for asplain-1.1.4-py3-none-any.whl:

Publisher: deploy.yml on potassco/asplain

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page