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.2.1.tar.gz (933.3 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.2.1-py3-none-any.whl (53.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: asplain-1.2.1.tar.gz
  • Upload date:
  • Size: 933.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for asplain-1.2.1.tar.gz
Algorithm Hash digest
SHA256 21852db673087ad1f338f80496ca83ed9a059c8ebd95b33c4b156530843d4390
MD5 30171b79b97b63172ae6e20e349ff099
BLAKE2b-256 cd681abb2e545cade95615ce368ef3c3c7c49c68a53c58be39ed7da4de37d35a

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: asplain-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 53.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for asplain-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 35939bf010ba026e09627a6ce8396925e5b9a70a795827ab98a7e7f0e9ffe0c3
MD5 08086352ef1204995ad9d39d568635e4
BLAKE2b-256 4d9f184379298a744ec720490f479142ad463ed8cef5546d074f5e5a1293f659

See more details on using hashes here.

Provenance

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