musclingo 0.1.2__tar.gz

musclingo-0.1.2/.envrc

@@ -0,0 +1,11 @@
+# automatically activate dev environment when in project tree using direnv.
+ACT=".nox/dev/bin/activate"
+
+if [[ -f "${ACT}" ]]; then
+    source "${ACT}"
+else
+    cat <<EOF
+Activation script "${ACT}" not found for dev environment.
+Run 'nox -s dev' to install dev environment
+EOF
+fi

musclingo-0.1.2/.github/workflows/deploy.yml

@@ -0,0 +1,48 @@
+name: deploy to pypi
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+
+  deploy:
+    name: deploy
+    needs: test
+    permissions:
+      id-token: write
+    environment: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.11
+
+      - name: install build dependencies
+        run: python3 -m pip install build
+
+      - name: build package
+        run: python3 -m build --sdist --wheel --outdir dist/
+
+      - name: upload package
+        uses: actions/upload-artifact@v7
+        with:
+          name: package
+          path: dist/
+      - name: publish package (pypi)
+        if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: publish package (test.pypi)
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: "https://test.pypi.org/legacy/"

musclingo-0.1.2/.github/workflows/doc.yml

@@ -0,0 +1,51 @@
+name: Deploy Documentation
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.12
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e .[doc]
+      - name: Build the documentation
+        run: mkdocs build
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v6
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: "./site"
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

musclingo-0.1.2/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: run CI test
+
+on:
+  push:
+    branches: [devel, main, master, wip]
+  pull_request:
+  workflow_call:
+
+env:
+  FORCE_COLOR: "3"
+
+jobs:
+  build:
+    name: test on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: |
+            3.11
+            3.14
+
+      - name: install requirements
+        run: python -m pip install .[dev] nox pre-commit
+
+      - name: run pre-commit
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        run: pre-commit run --all --show-diff-on-failure
+
+      - name: run tests
+        run: nox

musclingo-0.1.2/.gitignore

@@ -0,0 +1,40 @@
+# Editors
+.vscode/
+*~
+\#*\#
+.\#*
+
+# Mac/OSX
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+*egg-info*
+
+# uv
+uv.lock
+
+# unclassified
+dist
+build
+.coverage
+_build
+_autosummary
+site

musclingo-0.1.2/.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.8
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        exclude: ^.github/
+
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 1.0.0
+    hooks:
+      - id: mdformat
+        args: ["--wrap", "79"]
+        exclude: ^docs/
+        additional_dependencies:
+          - mdformat-gfm
+
+  - repo: https://github.com/astral-sh/ty-pre-commit
+    rev: v0.0.65
+    hooks:
+      - id: ty

musclingo-0.1.2/CHANGES.md

@@ -0,0 +1,5 @@
+# Changes
+
+## v0.1.0
+
+- create project

musclingo-0.1.2/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing
+
+Thanks for considering a contribution to musclingo.
+
+## How to get help or discuss possible contributions
+
+To avoid duplicating issues, please search our [issue tracker][issues] and our
+[mailing list][mailing_list] before filing a new issue.
+
+- Open an [issue][new_issue] describing your problem.
+- [Subscribe] to our mailing list on SourceForge.
+
+## How to make a contribution
+
+- Fork the [musclingo][project_url] repository and create a branch for your
+  changes.
+- Submit a pull request to the master branch with your changes.
+- Respond to feedback on your pull request.
+- If everything is fine your pull request is merged!
+
+## License
+
+When contributing to this project, you agree that you have authored 100% of the
+content, that you have the necessary rights to the content and that the content
+you contribute may be provided under the project license.
+
+[issues]: https://github.com/potassco/musclingo.git/issues/
+[mailing_list]: https://sourceforge.net/p/potassco/mailman/potassco-users/
+[new_issue]: https://github.com/potassco/musclingo.git/issues/new/
+[project_url]: https://github.com/potassco/musclingo.git/
+[subscribe]: https://sourceforge.net/projects/potassco/lists/potassco-users/

musclingo-0.1.2/DEPLOYMENT.md

@@ -0,0 +1,28 @@
+# Deployment
+
+Releases are deployed on [pypi] whenever a tag of form `vMajor.Minor.Revision`
+is pushed. Furthermore, the deployment workflow can be triggered manually to
+deploy test releases on [test.pypi].
+
+For this to work, the workflow has to be granted permission to deploy on the
+two services. Please follow this packaging [guide] to setup your accounts
+accordingly. We also recommend to setup a github [environment] to restrict
+which contributors can deploy packages.
+
+## Automatic Documentation Deployment
+
+You can automatically publish project documentation to GitHub Pages on every
+new tag. To enable this:
+
+- Go to your repository on GitHub.
+- Navigate to **Settings** > **Pages**.
+- Under **Build and deployment**, set **Source** to **GitHub Actions**.
+
+This setup ensures your documentation is updated whenever you create a new
+release tag via GitHub workflows. The final documentation will be made
+available at `https://potassco.org/musclingo/docs`.
+
+[environment]: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment/
+[guide]: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+[pypi]: https://pypi.org/
+[test.pypi]: https://test.pypi.org/

musclingo-0.1.2/DEVELOPMENT.md

@@ -0,0 +1,63 @@
+# Development
+
+To install the project in development mode, use the following command:
+
+```bash
+pip install -e .[dev]
+```
+
+To improve code quality, we use [nox] to run linters, type checkers, unit
+tests, and more. We recommend installing nox using [pipx] to have it available
+globally.
+
+```bash
+# install
+python -m pip install pipx
+python -m pipx install nox
+
+# run all sessions
+nox
+
+# list all sessions
+nox -l
+
+# run individual session
+nox -s session_name
+
+# run individual session (reuse install)
+nox -Rs session_name
+```
+
+Note that the nox sessions create [editable] installs. In case there are
+issues, try recreating environments by dropping the `-R` option. If your
+project is incompatible with editable installs, adjust the `noxfile.py` to
+disable them.
+
+We also provide a [pre-commit][pre] config to autoformat code upon commits. It
+can be set up using the following commands:
+
+```bash
+python -m pipx install pre-commit
+pre-commit install
+```
+
+## Documentation
+
+Make sure the documentation dependencies for the project are properly installed
+with
+
+```bash
+pip install .[doc]
+```
+
+To run the documentation locally use the following command and click the
+provided link to open it in the browser.
+
+```bash
+mkdocs serve
+```
+
+[editable]: https://setuptools.pypa.io/en/latest/userguide/development_mode.html
+[nox]: https://nox.thea.codes/en/stable/index.html
+[pipx]: https://pypa.github.io/pipx/
+[pre]: https://pre-commit.com/

musclingo-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Potassco
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

musclingo-0.1.2/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: musclingo
+Version: 0.1.2
+Summary: A package to compute MUSes of ASP programs.
+Author-email: Susana Hahn <susuhahnml@yahoo.com.mx>, Antonio Ielo <antonio.ielo@unical.it>, Hannes Weichelt <hweichelt@uni-potsdam.de>
+License: MIT License
+        
+        Copyright (c) 2024 Potassco
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/potassco/musclingo.git/
+Project-URL: Documentation, https://docs.potassco.org/musclingo/
+Project-URL: Repository, https://github.com/potassco/musclingo
+Project-URL: Issues, https://github.com/potassco/musclingo/issues
+Project-URL: Changelog, https://github.com/potassco/musclingo/blob/master/CHANGES.md
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: bidict>=0.23.1
+Requires-Dist: clingo>=5.8.0
+Provides-Extra: lint
+Requires-Dist: ruff; extra == "lint"
+Provides-Extra: typecheck
+Requires-Dist: pytest; extra == "typecheck"
+Requires-Dist: ty; extra == "typecheck"
+Requires-Dist: nox; extra == "typecheck"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: coverage[toml]; extra == "test"
+Provides-Extra: doc
+Requires-Dist: mkdocs; extra == "doc"
+Requires-Dist: mkdocs-material; extra == "doc"
+Requires-Dist: mkdocstrings>=1.0.4; extra == "doc"
+Requires-Dist: mkdocstrings-python>=2.0; extra == "doc"
+Requires-Dist: clindocs>=1.5.1; extra == "doc"
+Requires-Dist: mkdocs-literate-nav; extra == "doc"
+Requires-Dist: pygments_clingo; extra == "doc"
+Provides-Extra: dev
+Requires-Dist: musclingo[lint,test,typecheck]; extra == "dev"
+Dynamic: license-file
+
+[![Documentation](https://img.shields.io/badge/docs-potassco.org-blue)](https://docs.potassco.org/musclingo/)
+[![PyPI version](https://img.shields.io/pypi/v/musclingo)](https://pypi.org/project/musclingo/)
+[![License](https://img.shields.io/github/license/potassco/musclingo)](LICENSE)
+
+# musclingo
+
+## Installation
+
+To install the project from the repository, run
+
+```bash
+pip install .
+```
+
+To install the project from pypi run
+
+```bash
+pip install musclingo
+```
+
+## Documentation
+
+Full documentation is available at
+**[docs.potassco.org/musclingo](https://docs.potassco.org/musclingo/)**.

musclingo-0.1.2/README.md

@@ -0,0 +1,24 @@
+[![Documentation](https://img.shields.io/badge/docs-potassco.org-blue)](https://docs.potassco.org/musclingo/)
+[![PyPI version](https://img.shields.io/pypi/v/musclingo)](https://pypi.org/project/musclingo/)
+[![License](https://img.shields.io/github/license/potassco/musclingo)](LICENSE)
+
+# musclingo
+
+## Installation
+
+To install the project from the repository, run
+
+```bash
+pip install .
+```
+
+To install the project from pypi run
+
+```bash
+pip install musclingo
+```
+
+## Documentation
+
+Full documentation is available at
+**[docs.potassco.org/musclingo](https://docs.potassco.org/musclingo/)**.

musclingo-0.1.2/docs/SUMMARY.md

@@ -0,0 +1,17 @@
+* Getting Started
+    * [Quick Start Guide](use/quick-start.md)
+    * [Installation](use/installation.md)
+    * [Help](use/help.md)
+* Reference
+    * [Reference](reference/index.md)
+    * API Documentation
+        * [Algorithms](reference/api/algorithms.md)
+        * [Shrinking](reference/api/shrink.md)
+        * [Utils](reference/api/utils.md)
+* [Examples](examples/index.md)
+* Community
+    * [Community](community/index.md)
+    * [Contributing](community/CONTRIBUTING.md)
+    * [Changes](community/CHANGES.md)
+    * [Development](community/DEVELOPMENT.md)
+    * [Deployment](community/DEPLOYMENT.md)

musclingo-0.1.2/docs/_custom/css/extra.css

@@ -0,0 +1,181 @@
+/* ============================================================
+   Brand colors
+   ============================================================ */
+
+:root {
+    --md-primary-fg-color: #6495ED;
+}
+
+[data-md-color-scheme="default"] .md-header,
+[data-md-color-scheme="default"] .md-tabs,
+[data-md-color-scheme="slate"] .md-header,
+[data-md-color-scheme="slate"] .md-tabs {
+    --md-primary-fg-color: #2E3360;
+}
+
+[data-md-color-scheme="default"] .md-nav--primary .md-nav__title,
+[data-md-color-scheme="slate"] .md-nav--primary .md-nav__title {
+    background-color: #2E3360;
+}
+
+
+[data-md-color-scheme="default"] {
+    --md-footer-bg-color: #00000005;
+    --md-footer-bg-color--dark: #00000005;
+    --md-footer-fg-color--lighter: #000000;
+    --md-footer-fg-color--light: #000000;
+    /* --md-footer-fg-color: #000000; */
+}
+
+
+[data-md-color-scheme="slate"] {
+    --md-footer-bg-color: #00000060;
+    --md-footer-bg-color--dark: #00000060;
+    --md-footer-fg-color--lighter: #FFFFFF;
+    --md-footer-fg-color--light: #FFFFFF90;
+}
+
+/* ============================================================
+   Code highlight colors
+   ============================================================ */
+
+[data-md-color-scheme="default"] {
+    --md-code-hl-number-color: hsl(11, 80%, 40%);
+    --md-code-hl-special-color: hsl(340, 75%, 45%);
+    --md-code-hl-function-color: hsl(271, 55%, 45%);
+    --md-code-hl-constant-color: hsl(220, 70%, 45%);
+    --md-code-hl-keyword-color: var(--md-primary-fg-color);
+    --md-code-hl-string-color: hsl(160, 50%, 30%);
+    --md-code-hl-name-color: hsl(43, 90%, 32%);
+    --md-code-hl-operator-color: hsl(0, 0%, 30%);
+    --md-code-hl-punctuation-color: hsl(271, 45%, 45%);
+    --md-code-hl-comment-color: hsl(210, 15%, 50%);
+    --md-code-hl-generic-color: hsl(210, 15%, 45%);
+    --md-code-hl-variable-color: hsl(24, 70%, 38%);
+}
+
+[data-md-color-scheme="slate"] {
+    --md-code-hl-number-color: hsl(11, 85%, 68%);
+    --md-code-hl-special-color: hsl(340, 82%, 72%);
+    --md-code-hl-function-color: hsl(271, 70%, 78%);
+    --md-code-hl-constant-color: hsl(220, 80%, 75%);
+    --md-code-hl-keyword-color: #6fa3f7;
+    --md-code-hl-string-color: hsl(160, 55%, 60%);
+    --md-code-hl-name-color: hsl(43, 100%, 65%);
+    --md-code-hl-operator-color: hsl(0, 0%, 72%);
+    --md-code-hl-punctuation-color: hsl(271, 60%, 78%);
+    --md-code-hl-comment-color: hsl(210, 15%, 55%);
+    --md-code-hl-generic-color: hsl(210, 15%, 62%);
+    --md-code-hl-variable-color: hsl(24, 80%, 68%);
+}
+
+
+/* ============================================================
+   Layout
+   ============================================================ */
+
+.md-grid {
+    max-width: 1350px;
+}
+
+
+/* ============================================================
+   Header
+   ============================================================ */
+
+.md-header__title {
+    font-size: 1.2rem;
+    height: 2.5rem;
+    line-height: 2.5rem;
+    margin-left: 0 !important;
+}
+
+.md-header__button.md-logo {
+    padding-bottom: 0.8rem;
+}
+
+.md-header__button.md-logo img,
+.md-header__button.md-logo svg {
+    height: 1.5rem;
+    width: 1.5rem;
+}
+
+
+/* ============================================================
+   Admonitions
+   ============================================================ */
+
+.md-typeset .admonition,
+.md-typeset details {
+    border-width: 0;
+    border-left-width: 3px;
+}
+
+/* info / note / abstract / tip — primary color */
+.md-typeset .info>.admonition-title,
+.md-typeset .info>summary,
+.md-typeset .note>.admonition-title,
+.md-typeset .note>summary,
+.md-typeset .abstract>.admonition-title,
+.md-typeset .abstract>summary,
+.md-typeset .tip>.admonition-title,
+.md-typeset .tip>summary {
+    border-color: var(--md-primary-fg-color);
+    background-color: color-mix(in srgb, var(--md-primary-fg-color) 10%, transparent);
+}
+
+.md-typeset .admonition.info,
+.md-typeset details.info,
+.md-typeset .admonition.note,
+.md-typeset details.note,
+.md-typeset .admonition.abstract,
+.md-typeset details.abstract,
+.md-typeset .admonition.tip,
+.md-typeset details.tip {
+    border-color: var(--md-primary-fg-color);
+}
+
+.md-typeset .info>.admonition-title::before,
+.md-typeset .info>summary::before,
+.md-typeset .note>.admonition-title::before,
+.md-typeset .note>summary::before,
+.md-typeset .abstract>.admonition-title::before,
+.md-typeset .abstract>summary::before,
+.md-typeset .tip>.admonition-title::before,
+.md-typeset .tip>summary::before {
+    background-color: var(--md-primary-fg-color);
+}
+
+/* question — yellow */
+.md-typeset .question>.admonition-title,
+.md-typeset .question>summary {
+    border-color: #A8AD00;
+    background-color: color-mix(in srgb, #A8AD00 10%, transparent);
+}
+
+.md-typeset .admonition.question,
+.md-typeset details.question {
+    border-color: #A8AD00;
+}
+
+.md-typeset .question>.admonition-title::before,
+.md-typeset .question>summary::before {
+    background-color: #A8AD00;
+}
+
+/* success — green */
+.md-typeset .success>.admonition-title,
+.md-typeset .success>summary {
+    border-color: #A8AD00;
+    background-color: color-mix(in srgb, #A8AD00 10%, transparent);
+}
+
+.md-typeset .admonition.success,
+.md-typeset details.success {
+    border-color: #A8AD00;
+}
+
+.md-typeset .success>.admonition-title::before,
+.md-typeset .success>summary::before {
+    background-color: #A8AD00;
+}