galactic 0.4.0.0.post1.dev132__tar.gz

galactic-0.4.0.0.post1.dev132/.gitignore

@@ -0,0 +1,8 @@
+.coverage
+.idea/
+build/
+dist/
+.ipynb_checkpoints/
+__pycache__/
+.venv
+icon.png

galactic-0.4.0.0.post1.dev132/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2018-2026, The Galactic Organization
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

galactic-0.4.0.0.post1.dev132/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: galactic
+Version: 0.4.0.0.post1.dev132
+Summary: GALACTIC main application
+Project-URL: Homepage, https://www.thegalactic.org/
+Project-URL: Documentation, https://www.thegalactic.org/docs/apps/cli/main/
+Project-URL: Repository, https://gitlab.univ-lr.fr/galactic/public/src/apps/cli/galactic-app-cli-main
+Project-URL: Issues, https://gitlab.univ-lr.fr/galactic/public/src/apps/cli/galactic-app-cli-main/-/issues
+Project-URL: Icon, https://www.thegalactic.org/docs/apps/cli/main/latest/_static/icon.svg
+Project-URL: Icon-dark, https://www.thegalactic.org/docs/apps/cli/main/latest/_static/icon-dark.svg
+Project-URL: Index-public, https://www.thegalactic.org/pypi/public/simple/
+Author-email: The Galactic Organization <contact@thegalactic.org>
+Maintainer-email: The Galactic Organization <contact@thegalactic.org>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: application,formal concept analysis
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <3.15,>=3.11
+Requires-Dist: click~=8.3
+Requires-Dist: galactic-helper-core>=0.4.0.0.post1.dev
+Requires-Dist: platformdirs~=4.9
+Requires-Dist: rich-click~=1.9
+Description-Content-Type: text/x-rst
+
+Instructions
+============
+
+|hatch|
+|pre-commit|
+|ruff|
+|black|
+|doc8|
+|mypy|
+|pylint|
+|slotscheck|
+
+.. |hatch| image:: https://img.shields.io/badge/%F0%9F%A5%9A-hatch-4051b5.svg
+   :target: https://pypi.org/project/hatch/
+.. |pre-commit| image:: https://img.shields.io/badge/-pre--commit-brightgreen?logo=pre-commit&labelColor=gray
+   :target: https://pypi.org/project/pre-commit/
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :target: https://pypi.org/project/ruff/
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://pypi.org/project/black/
+.. |doc8| image:: https://img.shields.io/badge/static--checked-doc8-green
+   :target: https://pypi.org/project/doc8/
+.. |mypy| image:: https://img.shields.io/badge/static--checked-mypy-blue
+   :target: https://pypi.org/project/mypy/
+.. |pylint| image:: https://img.shields.io/badge/dynamic--checked-pylint-orange
+   :target: https://pypi.org/project/pylint/
+.. |slotscheck| image:: https://img.shields.io/badge/dynamic--checked-slotscheck-orange
+   :target: https://pypi.org/project/slotscheck/
+
+Prerequisite
+------------
+
+*galactic* requires `python 3.11`_,
+a programming language that comes pre-installed on linux and Mac OS X,
+and which is easily installed `on Windows`_;
+
+Installation
+------------
+
+Install *galactic* in a virtual (``conda`` or ``venv``)
+environment using the bash commands:
+
+.. code-block:: shell-session
+
+    (galactic) $ pip install galactic
+
+Don't forget to add the ``--pre`` flag if you want the latest unstable build.
+
+After installation, you can configure authenticated access to the
+**GALACTIC** package index with:
+
+.. code-block:: shell-session
+
+    (galactic) $ galactic config
+
+This command prompts for your GALACTIC password and stores it in your
+``pip.conf`` or ``pip.ini`` file.
+
+Contributing
+------------
+
+Build
+~~~~~
+
+Building *galactic* requires
+
+* `hatch`_, which is a tool for dependency management and packaging in Python;
+
+Build *galactic* using the bash command
+
+.. code-block:: shell-session
+
+    $ hatch build
+
+Testing
+~~~~~~~
+
+Test *galactic* using the bash command:
+
+.. code-block:: shell-session
+
+    $ hatch test
+
+for running the tests.
+
+.. code-block:: shell-session
+
+    $ hatch test --cover
+
+for running the tests with the coverage.
+
+.. code-block:: shell-session
+
+    $ hatch test --doctest-modules src
+
+for running the `doctest`.
+
+Linting
+~~~~~~~
+
+Lint *galactic* using the bash commands:
+
+.. code-block:: shell-session
+
+    $ hatch fmt --check
+
+for running static linting.
+
+.. code-block:: shell-session
+
+    $ hatch fmt
+
+for automatic fixing of static linting issues.
+
+.. code-block:: shell-session
+
+    $ hatch run lint:check
+
+for running dynamic linting.
+
+Documentation
+~~~~~~~~~~~~~
+
+Build the documentation using the bash commands:
+
+.. code-block:: shell-session
+
+    $ hatch run docs:build
+
+Getting Help
+~~~~~~~~~~~~
+
+.. important::
+
+    If you have any difficulties with *galactic*, please feel welcome to
+    `file an issue`_ on GitLab so that we can help.
+
+.. _file an issue: https://gitlab.univ-lr.fr/galactic/public/src/apps/cli/galactic-app-cli-main/-/issues
+.. _python 3.11: http://www.python.org
+.. _on Windows: https://www.python.org/downloads/windows
+.. _hatch: https://hatch.pypa.io/

galactic-0.4.0.0.post1.dev132/README.rst

@@ -0,0 +1,141 @@
+Instructions
+============
+
+|hatch|
+|pre-commit|
+|ruff|
+|black|
+|doc8|
+|mypy|
+|pylint|
+|slotscheck|
+
+.. |hatch| image:: https://img.shields.io/badge/%F0%9F%A5%9A-hatch-4051b5.svg
+   :target: https://pypi.org/project/hatch/
+.. |pre-commit| image:: https://img.shields.io/badge/-pre--commit-brightgreen?logo=pre-commit&labelColor=gray
+   :target: https://pypi.org/project/pre-commit/
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :target: https://pypi.org/project/ruff/
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://pypi.org/project/black/
+.. |doc8| image:: https://img.shields.io/badge/static--checked-doc8-green
+   :target: https://pypi.org/project/doc8/
+.. |mypy| image:: https://img.shields.io/badge/static--checked-mypy-blue
+   :target: https://pypi.org/project/mypy/
+.. |pylint| image:: https://img.shields.io/badge/dynamic--checked-pylint-orange
+   :target: https://pypi.org/project/pylint/
+.. |slotscheck| image:: https://img.shields.io/badge/dynamic--checked-slotscheck-orange
+   :target: https://pypi.org/project/slotscheck/
+
+Prerequisite
+------------
+
+*galactic* requires `python 3.11`_,
+a programming language that comes pre-installed on linux and Mac OS X,
+and which is easily installed `on Windows`_;
+
+Installation
+------------
+
+Install *galactic* in a virtual (``conda`` or ``venv``)
+environment using the bash commands:
+
+.. code-block:: shell-session
+
+    (galactic) $ pip install galactic
+
+Don't forget to add the ``--pre`` flag if you want the latest unstable build.
+
+After installation, you can configure authenticated access to the
+**GALACTIC** package index with:
+
+.. code-block:: shell-session
+
+    (galactic) $ galactic config
+
+This command prompts for your GALACTIC password and stores it in your
+``pip.conf`` or ``pip.ini`` file.
+
+Contributing
+------------
+
+Build
+~~~~~
+
+Building *galactic* requires
+
+* `hatch`_, which is a tool for dependency management and packaging in Python;
+
+Build *galactic* using the bash command
+
+.. code-block:: shell-session
+
+    $ hatch build
+
+Testing
+~~~~~~~
+
+Test *galactic* using the bash command:
+
+.. code-block:: shell-session
+
+    $ hatch test
+
+for running the tests.
+
+.. code-block:: shell-session
+
+    $ hatch test --cover
+
+for running the tests with the coverage.
+
+.. code-block:: shell-session
+
+    $ hatch test --doctest-modules src
+
+for running the `doctest`.
+
+Linting
+~~~~~~~
+
+Lint *galactic* using the bash commands:
+
+.. code-block:: shell-session
+
+    $ hatch fmt --check
+
+for running static linting.
+
+.. code-block:: shell-session
+
+    $ hatch fmt
+
+for automatic fixing of static linting issues.
+
+.. code-block:: shell-session
+
+    $ hatch run lint:check
+
+for running dynamic linting.
+
+Documentation
+~~~~~~~~~~~~~
+
+Build the documentation using the bash commands:
+
+.. code-block:: shell-session
+
+    $ hatch run docs:build
+
+Getting Help
+~~~~~~~~~~~~
+
+.. important::
+
+    If you have any difficulties with *galactic*, please feel welcome to
+    `file an issue`_ on GitLab so that we can help.
+
+.. _file an issue: https://gitlab.univ-lr.fr/galactic/public/src/apps/cli/galactic-app-cli-main/-/issues
+.. _python 3.11: http://www.python.org
+.. _on Windows: https://www.python.org/downloads/windows
+.. _hatch: https://hatch.pypa.io/

galactic-0.4.0.0.post1.dev132/docs/_templates/autosummary/module.rst

@@ -0,0 +1,12 @@
+.. raw:: html
+
+    <style>
+    /* Hide only the first H1 on this page */
+    h1:first-of-type {display: none !important;}
+    </style>
+
+{{ fullname | escape | underline }}
+
+:mod:`{{ fullname  }}` module
+
+.. automodule:: {{ fullname }}

galactic-0.4.0.0.post1.dev132/docs/_templates/components/prev-next.html

@@ -0,0 +1,27 @@
+{# Displays links to the previous and next page in the TOCtree order. #}
+<div class="prev-next-area">
+  {%- if prev %}
+    <a class="left-prev"
+       href="{{ prev.link|e }}"
+       title="{{ _('previous page') }}">
+      <i class="fa-solid fa-angle-left"></i>
+      <div class="prev-next-info">
+        <p class="prev-next-subtitle">{{ _("previous") }}</p>
+        {% set temp_title = prev_title or prev.title %}
+        <p class="prev-next-title">{{ '…' ~ temp_title[-30:] if temp_title|length > 30 else temp_title }}</p>
+      </div>
+    </a>
+  {%- endif %}
+  {%- if next %}
+    <a class="right-next"
+       href="{{ next.link|e }}"
+       title="{{ _('next page') }}">
+      <div class="prev-next-info">
+        <p class="prev-next-subtitle">{{ _("next") }}</p>
+        {% set temp_title = next_title or next.title %}
+        <p class="prev-next-title">{{ '…' ~ temp_title[-30:] if temp_title|length > 30 else temp_title }}</p>
+      </div>
+      <i class="fa-solid fa-angle-right"></i>
+    </a>
+  {%- endif %}
+</div>

galactic-0.4.0.0.post1.dev132/docs/api/apps/cli/main/index.rst

@@ -0,0 +1,8 @@
+🔌 CLI API
+==========
+
+.. autosummary::
+   :recursive:
+   :toctree: modules
+
+   galactic.apps.cli.main

galactic-0.4.0.0.post1.dev132/docs/api/apps/cli/main/modules/galactic.apps.cli.main.rst

@@ -0,0 +1,13 @@
+.. raw:: html
+
+    <style>
+    /* Hide only the first H1 on this page */
+    h1:first-of-type {display: none !important;}
+    </style>
+
+galactic.apps.cli.main
+======================
+
+:mod:`galactic.apps.cli.main` module
+
+.. automodule:: galactic.apps.cli.main

galactic-0.4.0.0.post1.dev132/docs/conf.py

@@ -0,0 +1,142 @@
+"""The configuration module for sphinx."""
+
+import json
+import os
+
+# Get metadata
+metadata = json.load(os.popen("hatch project metadata"))
+project = metadata["name"]
+author = ",".join(author["name"] for author in metadata["authors"])
+version = metadata["version"]
+project_copyright = f"2018-%Y, {author}"
+
+# -- General configuration ------------------------------------------------
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx_book_theme",
+    "nbsphinx",
+    "sphinxcontrib.plantuml",
+    "sphinx_autodoc_typehints",
+    "sphinx_codeautolink",
+    "sphinx_copybutton",
+    "sphinx_click",
+]
+
+copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+copybutton_prompt_is_regexp = True
+copybutton_line_continuation_character = "\\"
+
+add_module_names = False
+
+# nbsphinx settings
+nbsphinx_allow_errors = True
+
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = True
+napoleon_use_admonition_for_notes = True
+napoleon_use_admonition_for_references = True
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+
+# intersphinx setting
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
+
+# autodoc and autosummary settings
+autosummary_generate = True
+autodoc_member_order = "bysource"
+autodoc_default_options = {
+    "member-order": "bysource",
+    "members": True,
+    "show-inheritance": True,
+}
+
+typehints_defaults = "comma"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
+
+# The master toctree document.
+master_doc = "index"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ["_build", "**.ipynb_checkpoints"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_book_theme"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+    "max_navbar_depth": 1,
+    "logo": {
+        "image_dark": "icon-dark.svg",
+        "text": project[len("galactic-") :],
+    },
+    "use_download_button": False,
+    "use_fullscreen_button": False,
+    "switcher": {
+        "version_match": "latest",
+        "json_url": "/docs/apps/cli/main/versions.json",
+    },
+    "icon_links": [
+        {
+            "name": "GitLab",
+            "url": "https://gitlab.univ-lr.fr/galactic/public/src/apps/cli/galactic-app-cli-main/",
+            "icon": "fa-brands fa-gitlab",
+            "type": "fontawesome",
+        },
+    ],
+}
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+html_sidebars = {
+    "**": [
+        "navbar-logo.html",
+        "version-switcher.html",
+        "icon-links.html",
+        "search-button-field.html",
+        "sbt-sidebar-nav.html",
+    ],
+}
+html_show_sourcelink = False
+html_favicon = "thegalactic.ico"
+html_logo = "icon.svg"
+html_title = ""