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.6.tar.gz (928.9 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.6-py3-none-any.whl (51.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: asplain-1.1.6.tar.gz
  • Upload date:
  • Size: 928.9 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.6.tar.gz
Algorithm Hash digest
SHA256 f8116b7231f97af6c554958135538c5c27f4945896e68381ef733ed7e7dca077
MD5 6d7cd0ff4a6c023f112dd3bc758dcdd5
BLAKE2b-256 50bcc5daa5db21d498cf41958f03c54d3d5847968c31800f515891529b0f95be

See more details on using hashes here.

Provenance

The following attestation bundles were made for asplain-1.1.6.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.6-py3-none-any.whl.

File metadata

  • Download URL: asplain-1.1.6-py3-none-any.whl
  • Upload date:
  • Size: 51.4 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 2751ab17c0230dfd202fbd215d713d84b053ea89891eea50fd0064bec9516e88
MD5 99e5ccb9cf4753d046e691e87b6c5ae8
BLAKE2b-256 ff5a1776e69817700827f5b067f1d32045dd2d6a7481f8b3a8513bbf1ca39887

See more details on using hashes here.

Provenance

The following attestation bundles were made for asplain-1.1.6-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