galactic 0.4.0.0.post1.dev132__py3-none-any.whl

galactic/apps/cli/main/__init__.py

@@ -0,0 +1,27 @@
+"""
+Defines the public API for the CLI application module.
+"""
+
+__all__ = (
+    "application",
+    "error",
+    "info",
+    "warning",
+    "comment",
+    "prompt",
+    "confirm",
+    "AppStyles",
+    "Group",
+)
+
+from ._app import (
+    AppStyles,
+    Group,
+    application,
+    comment,
+    confirm,
+    error,
+    info,
+    prompt,
+    warning,
+)

galactic/apps/cli/main/__init__.pyi

@@ -0,0 +1,22 @@
+from typing import Any, ClassVar
+
+import rich_click as click
+
+class Group(click.Group):  # type: ignore[misc]
+    ...
+
+application: Group
+
+def error(text: str, **kwargs: Any) -> None: ...
+def info(text: str, **kwargs: Any) -> None: ...
+def warning(text: str, **kwargs: Any) -> None: ...
+def comment(text: str, **kwargs: Any) -> None: ...
+def prompt(text: str, **kwargs: Any) -> Any: ...
+def confirm(text: str, **kwargs: Any) -> bool: ...
+
+class AppStyles:
+    ERROR: ClassVar[dict[str, Any]]
+    WARNING: ClassVar[dict[str, Any]]
+    INFO: ClassVar[dict[str, Any]]
+    COMMENT: ClassVar[dict[str, Any]]
+    QUESTION: ClassVar[dict[str, Any]]

galactic/apps/cli/main/_app.py

@@ -0,0 +1,335 @@
+"""
+Main app module.
+"""
+
+from __future__ import annotations
+
+import os
+from typing import Any, ClassVar
+
+import rich_click as click
+
+from galactic.helpers.core import detect_plugins
+
+from ._pip_config import (
+    extract_url_username,
+    list_extra_index_urls,
+    redact_url_credentials,
+    resolve_pip_config_path,
+    write_pip_extra_index_url,
+)
+
+
+# pylint: disable=too-few-public-methods
+class AppStyles:
+    """
+    Styles used in application.
+
+    Attributes
+    ----------
+    ERROR
+        Style for errors (``{"fg": "red", "bold": True}`` by default).
+    WARNING
+        Style for warnings (``{"fg": "yellow", "bold": True}`` by default).
+    INFO
+        Style for informations (``{"fg": "bright_magenta"}`` by default).
+    COMMENT
+        Style for comments (``{"fg": "green"}`` by default).
+    QUESTION
+        Style for questions (``{"fg": "cyan"}`` by default).
+    """
+
+    ERROR: ClassVar[dict[str, Any]] = {"fg": "red", "bold": True}
+    WARNING: ClassVar[dict[str, Any]] = {"fg": "yellow", "bold": True}
+    INFO: ClassVar[dict[str, Any]] = {"fg": "bright_magenta"}
+    COMMENT: ClassVar[dict[str, Any]] = {"fg": "green"}
+    QUESTION: ClassVar[dict[str, Any]] = {"fg": "cyan"}
+
+
+def error(text: str, **kwargs: Any) -> None:
+    """
+    Display an error message.
+
+    Parameters
+    ----------
+    text
+        Text to display
+    **kwargs
+        Additional parameters passed to click.secho
+
+    """
+    click.secho(text, **AppStyles.ERROR, **kwargs)
+
+
+def info(text: str, **kwargs: Any) -> None:
+    """
+    Display an info message.
+
+    Parameters
+    ----------
+    text
+        Text to display
+    **kwargs
+        Additional parameters passed to click.secho
+
+    """
+    click.secho(text, **AppStyles.INFO, **kwargs)
+
+
+def warning(text: str, **kwargs: Any) -> None:
+    """
+    Display a warning.
+
+    Parameters
+    ----------
+    text
+        Text to display
+    **kwargs
+        Additional parameters passed to click.secho
+
+    """
+    click.secho(text, **AppStyles.WARNING, **kwargs)
+
+
+def comment(text: str, **kwargs: Any) -> None:
+    """
+    Display a comment.
+
+    Parameters
+    ----------
+    text
+        Text to display
+    **kwargs
+        Additional parameters passed to click.secho
+
+    """
+    click.secho(text, **AppStyles.COMMENT, **kwargs)
+
+
+def prompt(text: str, **kwargs: Any) -> Any:
+    """
+    Prompt the user.
+
+    Parameters
+    ----------
+    text
+        Text to display
+    **kwargs
+        Additional parameters passed to click.prompt
+
+    """
+    return click.prompt(click.style(text, **AppStyles.QUESTION), **kwargs)
+
+
+def confirm(text: str, **kwargs: Any) -> bool:
+    """
+    Prompt the user for a confirmation.
+
+    Parameters
+    ----------
+    text
+        Text to display
+    **kwargs
+        Additional parameters passed to click.confirm
+
+    """
+    return click.confirm(click.style(text, **AppStyles.QUESTION), **kwargs)
+
+
+def prompt_password_with_confirmation(text: str) -> str:
+    """
+    Prompt a hidden password twice and allow empty values.
+
+    Parameters
+    ----------
+    text
+        Prompt displayed for the first password entry.
+
+    Returns
+    -------
+    str
+        Confirmed password.
+
+    """
+    while True:
+        password = prompt(
+            text,
+            default="",
+            hide_input=True,
+            show_default=False,
+            type=str,
+        )
+        confirmation = prompt(
+            "Confirm password",
+            default="",
+            hide_input=True,
+            show_default=False,
+            type=str,
+        )
+        if password == confirmation:
+            return password
+        error("Passwords do not match. Please retry.")
+
+
+# pylint: disable=too-few-public-methods
+class AppEnvVars:
+    """
+    Environment variables.
+
+    Attributes
+    ----------
+    NO_COLOR
+        Name of environment variable for no-color.
+    FORCE_COLOR
+        Name of environment variable for force color.
+    """
+
+    # https://no-color.org
+    NO_COLOR = "NO_COLOR"
+    FORCE_COLOR = "FORCE_COLOR"
+
+
+class Group(click.Group):  # type: ignore[misc]
+    """
+    Group class for the GALACTIC app.
+
+    It does two things:
+
+    * it detects plugins from the galactic.apps.cli.main group.
+    * it adds an epilog to all added commands.
+    """
+
+    _plugins_detected = False
+
+    @classmethod
+    def detect_plugins(cls) -> None:
+        """
+        Detect plugins from the galactic.apps.cli.main group.
+        """
+        if not cls._plugins_detected:
+            detect_plugins(group="galactic.apps.cli.main")
+            cls._plugins_detected = True
+
+    def list_commands(self, ctx: click.Context) -> list[str]:
+        """
+        List commands in the group.
+
+        Parameters
+        ----------
+        ctx
+            The click context
+
+        Returns
+        -------
+        list[str]
+            List of command names in the group
+
+        """
+        self.detect_plugins()
+        return super().list_commands(ctx)
+
+    def get_command(self, ctx: click.Context, cmd_name: str) -> click.Command | None:
+        """
+        Get a command by name.
+
+        Parameters
+        ----------
+        ctx
+            The click context
+        cmd_name
+            The name of the command to get
+
+        Returns
+        -------
+        click.Command | None
+            The command if found, otherwise None
+
+        """
+        self.detect_plugins()
+        return super().get_command(ctx, cmd_name)
+
+    def add_command(self, cmd: click.Command, name: str | None = None) -> None:
+        """
+        Add a command to the group.
+
+        This method also sets the epilog of the command to the application's epilog.
+        It is useful for commands that are part of the application and should
+        inherit the application's epilog.
+
+        Parameters
+        ----------
+        cmd
+            The command to add
+        name
+            The name of the command (if None, the name of the command is used)
+
+        """
+        cmd.epilog = cmd.epilog or application.epilog
+        super().add_command(cmd, name)
+
+
+@click.version_option(package_name="galactic")  # type: ignore[untyped-decorator]
+@click.group(  # type: ignore[untyped-decorator]
+    name="galactic",
+    cls=Group,
+    epilog="GAlois LAttices, Concept Theory, Implicational systems and Closures.",
+)
+@click.pass_context  # type: ignore[untyped-decorator]
+def application(ctx: click.Context) -> int:
+    """
+    GALACTIC main application.
+    """
+    if os.environ.get(AppEnvVars.NO_COLOR) == "1":
+        ctx.color = False
+    elif os.environ.get(AppEnvVars.FORCE_COLOR) == "1":
+        ctx.color = True
+    return 0
+
+
+@application.command()  # type: ignore[untyped-decorator]
+def config() -> None:
+    """
+    Configure access to the GALACTIC package index.
+    """
+    config_path = resolve_pip_config_path()
+    backup_path = config_path.with_name(f"{config_path.name}.old")
+    had_existing_config = config_path.exists()
+    existing_urls = list_extra_index_urls(config_path)
+
+    selected_url: str | None = None
+    if len(existing_urls) > 1:
+        info("Several extra-index-url entries were found:")
+        for idx, url in enumerate(existing_urls, start=1):
+            comment(f"{idx}. {redact_url_credentials(url)}")
+        selected_index = prompt(
+            "Which index URL do you want to configure?",
+            default=1,
+            type=click.IntRange(min=1, max=len(existing_urls)),
+            show_default=True,
+        )
+        selected_url = existing_urls[selected_index - 1]
+    elif len(existing_urls) == 1:
+        selected_url = existing_urls[0]
+
+    if selected_url is not None and not confirm(
+        "Index URL already present in "
+        f"{config_path}: {redact_url_credentials(selected_url)}. "
+        "Update credentials?",
+        default=False,
+    ):
+        return
+
+    default_username = extract_url_username(selected_url) if selected_url else None
+    username = prompt(
+        "Username",
+        default=default_username or "__token__",
+        show_default=True,
+        type=str,
+    )
+    password = prompt_password_with_confirmation(
+        "Password (hit enter if you have no password)",
+    )
+    write_pip_extra_index_url(username, password, config_path, selected_url)
+    if had_existing_config:
+        warning(f"Previous configuration stored in {backup_path}.")
+    info(f"Stored credentials in {config_path}.")

galactic/apps/cli/main/_pip_config.py

@@ -0,0 +1,516 @@
+"""
+Utilities for pip configuration.
+"""
+
+from __future__ import annotations
+
+import os
+import re
+import shutil
+import sys
+from configparser import ConfigParser
+from pathlib import Path
+from typing import TYPE_CHECKING
+from urllib.parse import quote, unquote, urlsplit, urlunsplit
+
+import platformdirs
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+
+
+PIP_CONFIG_FILE_ENV_VAR = "PIP_CONFIG_FILE"
+VIRTUAL_ENV_ENV_VAR = "VIRTUAL_ENV"
+CONDA_PREFIX_ENV_VAR = "CONDA_PREFIX"
+WINDOWS_PIP_CONFIG_FILENAME = "pip.ini"
+UNIX_PIP_CONFIG_FILENAME = "pip.conf"
+INDEX_HOSTNAME = "www.thegalactic.org"
+PACKAGE_INDEX_URL = "https://www.thegalactic.org/pypi/simple/"
+GLOBAL_SECTION = "global"
+EXTRA_INDEX_URL_OPTION = "extra-index-url"
+
+
+def pip_config_filename() -> str:
+    """
+    Return the pip configuration filename for the current platform.
+
+    Returns
+    -------
+    str
+        ``pip.ini`` on Windows, ``pip.conf`` elsewhere.
+
+    """
+    if sys.platform.startswith("win"):
+        return WINDOWS_PIP_CONFIG_FILENAME
+    return UNIX_PIP_CONFIG_FILENAME
+
+
+def resolve_pip_config_path(
+    *,
+    env: Mapping[str, str] | None = None,
+) -> Path:
+    """
+    Resolve the pip configuration file path.
+
+    The resolution follows this priority order:
+
+    1. ``PIP_CONFIG_FILE`` environment variable (explicit override).
+    3. ``CONDA_PREFIX`` — path inside the active conda environment.
+    2. ``VIRTUAL_ENV`` — path inside the active virtual environment.
+    4. User-level config directory resolved by :mod:`platformdirs`.
+
+    Parameters
+    ----------
+    env
+        Environment variables mapping. Defaults to :data:`os.environ`.
+
+    Returns
+    -------
+    Path
+        The path to the pip configuration file.
+
+    """
+    environment: Mapping[str, str] = env if env is not None else os.environ
+    filename = pip_config_filename()
+
+    # Priority 1: explicit override
+    if pip_config_file := environment.get(PIP_CONFIG_FILE_ENV_VAR):
+        return Path(pip_config_file)
+
+    # Priority 2: inside a conda environment
+    if conda_prefix := environment.get(CONDA_PREFIX_ENV_VAR):
+        return Path(conda_prefix) / filename
+
+    # Priority 3: inside a virtual environment
+    if virtual_env := environment.get(VIRTUAL_ENV_ENV_VAR):
+        return Path(virtual_env) / filename
+
+    # Priority 4: user-level config resolved by platformdirs
+    return platformdirs.user_config_path("pip") / filename
+
+
+def build_package_index_url(password: str, username: str = "__token__") -> str:
+    """
+    Build the authenticated GALACTIC package index URL.
+
+    Parameters
+    ----------
+    password
+        Password to embed in the URL.
+    username
+        Username to embed in the URL (``__token__`` by default).
+
+    Returns
+    -------
+    str
+        The package index URL with credentials embedded.
+
+    """
+    return with_url_credentials(PACKAGE_INDEX_URL, username=username, password=password)
+
+
+def list_extra_index_urls(path: Path) -> list[str]:
+    """
+    Return configured ``extra-index-url`` entries from a pip config file.
+
+    Parameters
+    ----------
+    path
+        Path to the pip configuration file.
+
+    Returns
+    -------
+    list[str]
+        Parsed URL entries, in file order.
+
+    """
+    if not path.exists():
+        return []
+
+    config = ConfigParser(interpolation=None)
+    config.read(path, encoding="utf-8")
+    existing_raw = config.get(GLOBAL_SECTION, EXTRA_INDEX_URL_OPTION, fallback="")
+    return [url for raw in existing_raw.splitlines() for url in raw.split() if url]
+
+
+def with_url_credentials(url: str, *, username: str, password: str) -> str:
+    """
+    Return ``url`` with explicit credentials in its netloc.
+
+    Parameters
+    ----------
+    url
+        Base URL to update.
+    username
+        Username to inject.
+    password
+        Password to inject.
+
+    Returns
+    -------
+    str
+        URL containing ``username:password`` credentials.
+
+    """
+    parsed = urlsplit(url)
+    if not parsed.scheme or not parsed.hostname:
+        return url
+
+    user = quote(username, safe="")
+    secret = quote(password, safe="")
+
+    host = _as_text(parsed.hostname)
+    if parsed.port is not None:
+        host = f"{host}:{parsed.port}"
+    if user:
+        host = f"{user}:{secret}@{host}"
+
+    scheme = _as_text(parsed.scheme)
+    path = _as_text(parsed.path)
+    query = _as_text(parsed.query)
+    fragment = _as_text(parsed.fragment)
+
+    return urlunsplit((scheme, host, path, query, fragment))
+
+
+def redact_url_credentials(url: str) -> str:
+    """
+    Return ``url`` without embedded credentials.
+
+    Parameters
+    ----------
+    url
+        URL potentially containing ``username:password``.
+
+    Returns
+    -------
+    str
+        URL with user-info stripped from netloc.
+
+    """
+    parsed = urlsplit(url)
+    if not parsed.scheme or not parsed.hostname:
+        return url
+
+    host = _as_text(parsed.hostname)
+    if parsed.port is not None:
+        host = f"{host}:{parsed.port}"
+
+    scheme = _as_text(parsed.scheme)
+    path = _as_text(parsed.path)
+    query = _as_text(parsed.query)
+    fragment = _as_text(parsed.fragment)
+    return urlunsplit((scheme, host, path, query, fragment))
+
+
+def extract_url_username(url: str) -> str | None:
+    """
+    Extract the username embedded in ``url`` credentials.
+
+    Parameters
+    ----------
+    url
+        URL that may contain user-info.
+
+    Returns
+    -------
+    str | None
+        Decoded username when present, otherwise ``None``.
+
+    """
+    parsed = urlsplit(url)
+    if parsed.username is None:
+        return None
+    username = unquote(_as_text(parsed.username))
+    return username or None
+
+
+def is_galactic_url_configured(path: Path) -> bool:
+    """
+    Check whether a GALACTIC index URL is already present in a pip config file.
+
+    Parameters
+    ----------
+    path
+        Path to the pip configuration file.
+
+    Returns
+    -------
+    bool
+        ``True`` if at least one ``extra-index-url`` entry references
+        :data:`INDEX_HOSTNAME`, ``False`` otherwise (including when the file
+        does not exist).
+
+    """
+    return any(INDEX_HOSTNAME in url for url in list_extra_index_urls(path))
+
+
+def write_pip_extra_index_url(
+    username: str,
+    password: str,
+    path: Path,
+    target_url: str | None = None,
+) -> str:
+    """
+    Write the GALACTIC extra index URL to a pip configuration file.
+
+    Parameters
+    ----------
+    username
+        Username to store in the authenticated URL.
+    password
+        Password to store in the authenticated URL.
+    path
+        Path to the pip configuration file.
+    target_url
+        Existing URL to update. If ``None``, use the GALACTIC URL when no
+        ``extra-index-url`` is configured.
+
+    Returns
+    -------
+    str
+        Final URL that has been configured with credentials.
+
+    """
+    all_urls = list_extra_index_urls(path)
+
+    selected_url = target_url
+    if selected_url is None and not all_urls:
+        selected_url = PACKAGE_INDEX_URL
+    elif selected_url is None and len(all_urls) == 1:
+        selected_url = all_urls[0]
+
+    if selected_url is None:
+        raise ValueError(
+            "target_url must be provided when multiple URLs are configured",
+        )
+
+    configured_url = with_url_credentials(
+        selected_url,
+        username=username,
+        password=password,
+    )
+
+    updated = False
+    for index, url in enumerate(all_urls):
+        if url == selected_url:
+            all_urls[index] = configured_url
+            updated = True
+            break
+
+    if not updated:
+        all_urls.append(configured_url)
+
+    new_content = _upsert_extra_index_url_option(
+        original_content=path.read_text(encoding="utf-8") if path.exists() else "",
+        urls=all_urls,
+    )
+
+    path.parent.mkdir(parents=True, exist_ok=True)
+    if path.exists():
+        backup_path = path.with_name(f"{path.name}.old")
+        shutil.copy2(path, backup_path)
+    path.write_text(new_content, encoding="utf-8")
+
+    return configured_url
+
+
+# pylint: disable=too-many-locals, too-many-branches
+def _upsert_extra_index_url_option(*, original_content: str, urls: list[str]) -> str:
+    """Update only `[global].extra-index-url` while preserving surrounding text."""
+    newline = _detect_newline(original_content)
+    section_re = re.compile(r"^\s*\[(?P<name>[^\]]+)\]\s*$", re.IGNORECASE)
+    option_re = re.compile(r"^(?P<indent>\s*)extra-index-url\s*=.*$", re.IGNORECASE)
+
+    lines = original_content.splitlines(keepends=True)
+    section_start: int | None = None
+    section_end = len(lines)
+
+    for index, line in enumerate(lines):
+        match = section_re.match(line.rstrip("\r\n"))
+        if match and match.group("name").strip().lower() == GLOBAL_SECTION:
+            section_start = index
+            for after in range(index + 1, len(lines)):
+                if section_re.match(lines[after].rstrip("\r\n")):
+                    section_end = after
+                    break
+            break
+
+    replacement = _render_extra_index_option_lines(
+        urls,
+        newline=newline,
+        indent="",
+    )
+
+    if section_start is None:
+        if lines and not lines[-1].endswith(("\n", "\r")):
+            lines[-1] = lines[-1] + newline
+        if lines and lines[-1].strip():
+            lines.append(newline)
+        lines.append(f"[{GLOBAL_SECTION}]{newline}")
+        lines.extend(replacement)
+        return "".join(lines)
+
+    option_start: int | None = None
+    option_end = section_end
+    option_indent = ""
+    for index in range(section_start + 1, section_end):
+        stripped = lines[index].rstrip("\r\n")
+        match = option_re.match(stripped)
+        if match:
+            option_start = index
+            option_indent = match.group("indent")
+            for after in range(index + 1, section_end):
+                candidate = lines[after].rstrip("\r\n")
+                if not candidate:
+                    continue
+                if candidate.startswith((" ", "\t")):
+                    continue
+                if section_re.match(candidate):
+                    break
+                option_end = after
+                break
+            else:
+                option_end = section_end
+            break
+
+    if option_start is None:
+        insertion_at = section_end
+        if insertion_at > section_start + 1 and lines[insertion_at - 1].strip():
+            lines.insert(insertion_at, newline)
+            insertion_at += 1
+        lines[insertion_at:insertion_at] = _render_extra_index_option_lines(
+            urls,
+            newline=newline,
+            indent="",
+        )
+        return "".join(lines)
+
+    lines[option_start:option_end] = _rewrite_option_block_preserving_positions(
+        lines[option_start:option_end],
+        urls,
+        newline=newline,
+        option_indent=option_indent,
+    )
+    return "".join(lines)
+
+
+def _render_extra_index_option_lines(
+    urls: list[str],
+    *,
+    newline: str,
+    indent: str,
+) -> list[str]:
+    if len(urls) == 1:
+        return [f"{indent}{EXTRA_INDEX_URL_OPTION} = {urls[0]}{newline}"]
+    rendered = [f"{indent}{EXTRA_INDEX_URL_OPTION} ={newline}"]
+    rendered.extend(f"{indent}    {url}{newline}" for url in urls)
+    return rendered
+
+
+def _rewrite_option_block_preserving_positions(
+    original_option_lines: list[str],
+    urls: list[str],
+    *,
+    newline: str,
+    option_indent: str,
+) -> list[str]:
+    """Rewrite URL lines in an option block while keeping other lines unchanged."""
+    if not original_option_lines:
+        return _render_extra_index_option_lines(
+            urls,
+            newline=newline,
+            indent=option_indent,
+        )
+
+    url_slots: list[tuple[str, str]] = []
+    passthrough: dict[int, str] = {}
+
+    first = original_option_lines[0].rstrip("\r\n")
+    first_match = re.match(
+        r"^(?P<prefix>\s*extra-index-url\s*=\s*)(?P<value>.*)$",
+        first,
+        re.IGNORECASE,
+    )
+    if first_match is None:
+        return _render_extra_index_option_lines(
+            urls,
+            newline=newline,
+            indent=option_indent,
+        )
+
+    first_value = first_match.group("value").strip()
+    first_prefix = first_match.group("prefix")
+    if _is_url_value_line(first_value):
+        url_slots.append((first_prefix, "first"))
+    else:
+        passthrough[0] = (
+            f"{first_prefix}{newline}" if not first_value else f"{first}{newline}"
+        )
+
+    for index, raw_line in enumerate(original_option_lines[1:], start=1):
+        line = raw_line.rstrip("\r\n")
+        stripped = line.strip()
+        if not stripped or stripped.startswith(("#", ";")):
+            passthrough[index] = f"{line}{newline}"
+            continue
+        indent_match = re.match(r"^(\s*)", line)
+        slot_prefix = indent_match.group(1) if indent_match else ""
+        url_slots.append((slot_prefix, "cont"))
+
+    result: list[str] = []
+    url_index = 0
+    total_lines = len(original_option_lines)
+    slot_index = 0
+
+    for index in range(total_lines):
+        if index in passthrough:
+            result.append(passthrough[index])
+            continue
+        if url_index >= len(urls):
+            slot_index += 1
+            continue
+        prefix = url_slots[slot_index][0]
+        result.append(f"{prefix}{urls[url_index]}{newline}")
+        url_index += 1
+        slot_index += 1
+
+    while url_index < len(urls):
+        if url_slots:
+            base_prefix = url_slots[-1][0]
+            continuation_prefix = (
+                base_prefix if base_prefix.strip() else f"{option_indent}    "
+            )
+        else:
+            continuation_prefix = f"{option_indent}    "
+        result.append(f"{continuation_prefix}{urls[url_index]}{newline}")
+        url_index += 1
+
+    if result and not result[0].lower().lstrip().startswith("extra-index-url"):
+        return _render_extra_index_option_lines(
+            urls,
+            newline=newline,
+            indent=option_indent,
+        )
+
+    return result
+
+
+def _is_url_value_line(value: str) -> bool:
+    if not value:
+        return False
+    return not value.startswith(("#", ";"))
+
+
+def _detect_newline(content: str) -> str:
+    if "\r\n" in content:
+        return "\r\n"
+    return "\n"
+
+
+def _as_text(value: str | bytes | None) -> str:
+    if value is None:
+        return ""
+    if isinstance(value, bytes):
+        return value.decode()
+    return value

galactic-0.4.0.0.post1.dev132.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,10 @@
+galactic/apps/cli/main/__init__.py,sha256=WTAPb5xi8j38e0Ol5zAs4l42BFwQO3qWi9JIbDI1Hsc,349
+galactic/apps/cli/main/__init__.pyi,sha256=4IoZmUoosDWFDRh5mjLKH8F5YkaOmLQ21MDFGaX-1TY,642
+galactic/apps/cli/main/_app.py,sha256=KXU8e-Rc2t96QtdlftQrB4_tCZG7YYenpeKo4h6uD6Q,8361
+galactic/apps/cli/main/_pip_config.py,sha256=lFYQoAH6HL2VJBhCoTJz_BwSycX4rND7jat2egKlDQQ,14350
+galactic/apps/cli/main/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+galactic-0.4.0.0.post1.dev132.dist-info/METADATA,sha256=Vs3Opf43t1uIH4LQNRwNl2jVfMf7-5tV1ixEvVoOIyM,4950
+galactic-0.4.0.0.post1.dev132.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+galactic-0.4.0.0.post1.dev132.dist-info/entry_points.txt,sha256=xiTJDeF4B8NgXGgNE4bKmedDDGxf23Puwmfm1r3-N3o,64
+galactic-0.4.0.0.post1.dev132.dist-info/licenses/LICENSE,sha256=9teLJoARXQ4o8xNJqYK8RmWCwTKvdLmdoHzqnStMAYE,1530
+galactic-0.4.0.0.post1.dev132.dist-info/RECORD,,

galactic-0.4.0.0.post1.dev132.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

galactic-0.4.0.0.post1.dev132.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+galactic = galactic.apps.cli.main:application

galactic-0.4.0.0.post1.dev132.dist-info/licenses/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.