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-0.0.0.tar.gz (927.7 kB view details)

Uploaded Source

Built Distribution

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

asplain-0.0.0-py3-none-any.whl (49.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for asplain-0.0.0.tar.gz
Algorithm Hash digest
SHA256 0a6def2c3f17c9832f7a2d1fae39a9bf76c9a9f3e3a3e390d90a9b9b6cfb6663
MD5 933c11b552f1a5e495304d766df6fe6e
BLAKE2b-256 16b71ece9729965bc64b35d7dbef23ad0e469402184bc216a89b4d54345d13a1

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for asplain-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c8e8ab24166d1e1d8269ff6465e887a6e01f3f30acef7331a31f8adfb1db93ec
MD5 7eb0444d45eebc8cd832d16c0f6cc0d0
BLAKE2b-256 0e8fb9155f5f409258dcf6118dec0cab291f0c6c8813d8a37e2c895d9f9fec46

See more details on using hashes here.

Provenance

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