Fix griffelib/griffecli separation and add proper exports

Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>

Author: Copilot

packages/griffecli/pyproject.toml

@@ -41,8 +41,15 @@ classifiers = [
     "Typing :: Typed",
 ]
 
+[project.scripts]
+griffecli = "griffecli:main"
+
 [tool.hatch.metadata.hooks.uv-dynamic-versioning]
+dependencies = ["griffelib=={version}", "colorama>=0.4"]
 
 [tool.hatch.metadata.hooks.uv-dynamic-versioning.optional-dependencies]
 
 [tool.hatch.build.targets.sdist]
+
+[tool.hatch.build.targets.wheel]
+sources = ["src/"]

packages/griffecli/src/griffecli/__init__.py

@@ -1 +1,27 @@
-# TODO: Cut proper imports from griffelib `__init__.py` module
+# This top-level module imports all public names from the CLI package,
+# and exposes them as public objects.
+
+"""Griffe CLI package.
+
+The CLI (Command Line Interface) for the griffe library.
+This package provides command-line tools for interacting with griffe.
+
+## CLI entrypoints
+
+- [`griffecli.main`][]: Run the main program.
+- [`griffecli.check`][]: Check for API breaking changes in two versions of the same package.
+- [`griffecli.dump`][]: Load packages data and dump it as JSON.
+- [`griffecli.get_parser`][]: Get the argument parser for the CLI.
+"""
+
+from __future__ import annotations
+
+from griffecli._internal.cli import DEFAULT_LOG_LEVEL, check, dump, get_parser, main
+
+__all__ = [
+    "DEFAULT_LOG_LEVEL",
+    "check",
+    "dump",
+    "get_parser",
+    "main",
+]

packages/griffecli/src/griffecli/__main__.py

@@ -1,4 +1,4 @@
-# Entry-point module, in case you use `python -m griffelib`.
+# Entry-point module, in case you use `python -m griffecli`.
 #
 # Why does this file exist, and why `__main__`? For more info, read:
 #

packages/griffecli/src/griffecli/_internal/cli.py

@@ -4,11 +4,11 @@
 # We might be tempted to import things from `__main__` later,
 # but that will cause problems; the code will get executed twice:
 #
-# - When we run `python -m griffelib`, Python will execute
+# - When we run `python -m griffecli`, Python will execute
 #   `__main__.py` as a script. That means there won't be any
-#   `griffelib.__main__` in `sys.modules`.
+#   `griffecli.__main__` in `sys.modules`.
 # - When you import `__main__` it will get executed again (as a module) because
-#   there's no `griffelib.__main__` in `sys.modules`.
+#   there's no `griffecli.__main__` in `sys.modules`.
 
 from __future__ import annotations
 

packages/griffelib/pyproject.toml

@@ -44,5 +44,9 @@ classifiers = [
 [tool.hatch.metadata.hooks.uv-dynamic-versioning]
 
 [tool.hatch.metadata.hooks.uv-dynamic-versioning.optional-dependencies]
+pypi = ["pip>=24.0", "platformdirs>=4.2", "wheel>=0.42"]
 
 [tool.hatch.build.targets.sdist]
+
+[tool.hatch.build.targets.wheel]
+sources = ["src/"]

packages/griffelib/src/griffelib/__init__.py

@@ -2,143 +2,136 @@
 # and exposes them as public objects. We have tests to make sure
 # no object is forgotten in this list.
 
-"""Griffe package.
+"""Griffe library package.
 
 Signatures for entire Python programs.
 Extract the structure, the frame, the skeleton of your project,
 to generate API documentation or find breaking changes in your API.
 
-The entirety of the public API is exposed here, in the top-level `griffelib` module.
+The entirety of the library API is exposed here, in the top-level `griffelib` module.
+For backward compatibility, you can also import from `griffe` which re-exports everything.
 
 All messages written to standard output or error are logged using the `logging` module.
-Our logger's name is set to `"griffelib"` and is public (you can rely on it).
-You can obtain the logger from the standard `logging` module: `logging.getLogger("griffelib")`.
+Our logger's name is set to `"griffe"` and is public (you can rely on it).
+You can obtain the logger from the standard `logging` module: `logging.getLogger("griffe")`.
 Actual logging messages are not part of the public API (they might change without notice).
 
 Raised exceptions throughout the package are part of the public API (you can rely on them).
 Their actual messages are not part of the public API (they might change without notice).
 
 The following paragraphs will help you discover the package's content.
 
-## CLI entrypoints
-
-Griffe provides a command-line interface (CLI) to interact with the package. The CLI entrypoints can be called from Python code.
-
-- [`griffecli.main`][]: Run the main program.
-- [`griffecli.check`][]: Check for API breaking changes in two versions of the same package.
-- [`griffecli.dump`][]: Load packages data and dump it as JSON.
-
 ## Loaders
 
 To load API data, Griffe provides several high-level functions.
 
-- [`griffelib.load`][]: Load and return a Griffe object.
-- [`griffelib.load_git`][]: Load and return a module from a specific Git reference.
-- [`griffelib.load_pypi`][]: Load and return a module from a specific package version downloaded using pip.
+- [`griffe.load`][]: Load and return a Griffe object.
+- [`griffe.load_git`][]: Load and return a module from a specific Git reference.
+- [`griffe.load_pypi`][]: Load and return a module from a specific package version downloaded using pip.
 
 ## Models
 
 The data loaded by Griffe is represented by several classes.
 
-- [`griffelib.Module`][]: The class representing a Python module.
-- [`griffelib.Class`][]: The class representing a Python class.
-- [`griffelib.Function`][]: The class representing a Python function or method.
-- [`griffelib.Attribute`][]: The class representing a Python attribute.
-- [`griffelib.Alias`][]: This class represents an alias, or indirection, to an object declared in another module.
+- [`griffe.Module`][]: The class representing a Python module.
+- [`griffe.Class`][]: The class representing a Python class.
+- [`griffe.Function`][]: The class representing a Python function or method.
+- [`griffe.Attribute`][]: The class representing a Python attribute.
+- [`griffe.Alias`][]: This class represents an alias, or indirection, to an object declared in another module.
 
 Additional classes are available to represent other concepts.
 
-- [`griffelib.Decorator`][]: This class represents a decorator.
-- [`griffelib.Parameters`][]: This class is a container for parameters.
-- [`griffelib.Parameter`][]: This class represent a function parameter.
+- [`griffe.Decorator`][]: This class represents a decorator.
+- [`griffe.Parameters`][]: This class is a container for parameters.
+- [`griffe.Parameter`][]: This class represent a function parameter.
 
 ## Agents
 
 Griffe is able to analyze code both statically and dynamically, using the following "agents".
 However most of the time you will only need to use the loaders above.
 
-- [`griffelib.visit`][]: Parse and visit a module file.
-- [`griffelib.inspect`][]: Inspect a module.
+- [`griffe.visit`][]: Parse and visit a module file.
+- [`griffe.inspect`][]: Inspect a module.
 
 ## Serializers
 
 Griffe can serizalize data to dictionary and JSON.
 
-- [`griffelib.Object.as_json`][griffelib.Object.as_json]
-- [`griffelib.Object.from_json`][griffelib.Object.from_json]
-- [`griffelib.JSONEncoder`][]: JSON encoder for Griffe objects.
-- [`griffelib.json_decoder`][]: JSON decoder for Griffe objects.
+- [`griffe.Object.as_json`][griffe.Object.as_json]
+- [`griffe.Object.from_json`][griffe.Object.from_json]
+- [`griffe.JSONEncoder`][]: JSON encoder for Griffe objects.
+- [`griffe.json_decoder`][]: JSON decoder for Griffe objects.
 
 ## API checks
 
 Griffe can compare two versions of the same package to find breaking changes.
 
-- [`griffelib.find_breaking_changes`][]: Find breaking changes between two versions of the same API.
-- [`griffelib.Breakage`][]: Breakage classes can explain what broke from a version to another.
+- [`griffe.find_breaking_changes`][]: Find breaking changes between two versions of the same API.
+- [`griffe.Breakage`][]: Breakage classes can explain what broke from a version to another.
 
 ## Extensions
 
-Griffe supports extensions. You can create your own extension by subclassing the `griffelib.Extension` class.
+Griffe supports extensions. You can create your own extension by subclassing the `griffe.Extension` class.
 
-- [`griffelib.load_extensions`][]: Load configured extensions.
-- [`griffelib.Extension`][]: Base class for Griffe extensions.
+- [`griffe.load_extensions`][]: Load configured extensions.
+- [`griffe.Extension`][]: Base class for Griffe extensions.
 
 ## Docstrings
 
 Griffe can parse docstrings into structured data.
 
 Main class:
 
-- [`griffelib.Docstring`][]: This class represents docstrings.
+- [`griffe.Docstring`][]: This class represents docstrings.
 
 Docstring section and element classes all start with `Docstring`.
 
 Docstring parsers:
 
-- [`griffelib.parse`][]: Parse the docstring.
-- [`griffelib.parse_auto`][]: Parse a docstring by automatically detecting the style it uses.
-- [`griffelib.parse_google`][]: Parse a Google-style docstring.
-- [`griffelib.parse_numpy`][]: Parse a Numpydoc-style docstring.
-- [`griffelib.parse_sphinx`][]: Parse a Sphinx-style docstring.
+- [`griffe.parse`][]: Parse the docstring.
+- [`griffe.parse_auto`][]: Parse a docstring by automatically detecting the style it uses.
+- [`griffe.parse_google`][]: Parse a Google-style docstring.
+- [`griffe.parse_numpy`][]: Parse a Numpydoc-style docstring.
+- [`griffe.parse_sphinx`][]: Parse a Sphinx-style docstring.
 
 ## Exceptions
 
 Griffe uses several exceptions to signal errors.
 
-- [`griffelib.GriffeError`][]: The base exception for all Griffe errors.
-- [`griffelib.LoadingError`][]: Exception for loading errors.
-- [`griffelib.NameResolutionError`][]: Exception for names that cannot be resolved in a object scope.
-- [`griffelib.UnhandledEditableModuleError`][]: Exception for unhandled editables modules, when searching modules.
-- [`griffelib.UnimportableModuleError`][]: Exception for modules that cannot be imported.
-- [`griffelib.AliasResolutionError`][]: Exception for aliases that cannot be resolved.
-- [`griffelib.CyclicAliasError`][]: Exception raised when a cycle is detected in aliases.
-- [`griffelib.LastNodeError`][]: Exception raised when trying to access a next or previous node.
-- [`griffelib.RootNodeError`][]: Exception raised when trying to use siblings properties on a root node.
-- [`griffelib.BuiltinModuleError`][]: Exception raised when trying to access the filepath of a builtin module.
-- [`griffelib.ExtensionError`][]: Base class for errors raised by extensions.
-- [`griffelib.ExtensionNotLoadedError`][]: Exception raised when an extension could not be loaded.
-- [`griffelib.GitError`][]: Exception raised for errors related to Git.
+- [`griffe.GriffeError`][]: The base exception for all Griffe errors.
+- [`griffe.LoadingError`][]: Exception for loading errors.
+- [`griffe.NameResolutionError`][]: Exception for names that cannot be resolved in a object scope.
+- [`griffe.UnhandledEditableModuleError`][]: Exception for unhandled editables modules, when searching modules.
+- [`griffe.UnimportableModuleError`][]: Exception for modules that cannot be imported.
+- [`griffe.AliasResolutionError`][]: Exception for aliases that cannot be resolved.
+- [`griffe.CyclicAliasError`][]: Exception raised when a cycle is detected in aliases.
+- [`griffe.LastNodeError`][]: Exception raised when trying to access a next or previous node.
+- [`griffe.RootNodeError`][]: Exception raised when trying to use siblings properties on a root node.
+- [`griffe.BuiltinModuleError`][]: Exception raised when trying to access the filepath of a builtin module.
+- [`griffe.ExtensionError`][]: Base class for errors raised by extensions.
+- [`griffe.ExtensionNotLoadedError`][]: Exception raised when an extension could not be loaded.
+- [`griffe.GitError`][]: Exception raised for errors related to Git.
 
 # Expressions
 
 Griffe stores snippets of code (attribute values, decorators, base class, type annotations) as expressions.
 Expressions are basically abstract syntax trees (AST) with a few differences compared to the nodes returned by [`ast`][].
 Griffe provides a few helpers to extract expressions from regular AST nodes.
 
-- [`griffelib.get_annotation`][]: Get a type annotation as expression.
-- [`griffelib.get_base_class`][]: Get a base class as expression.
-- [`griffelib.get_class_keyword`][]: Get a class keyword as expression.
-- [`griffelib.get_condition`][]: Get a condition as expression.
-- [`griffelib.get_expression`][]: Get an expression from an AST node.
-- [`griffelib.safe_get_annotation`][]: Get a type annotation as expression, safely (returns `None` on error).
-- [`griffelib.safe_get_base_class`][]: Get a base class as expression, safely (returns `None` on error).
-- [`griffelib.safe_get_class_keyword`][]: Get a class keyword as expression, safely (returns `None` on error).
-- [`griffelib.safe_get_condition`][]: Get a condition as expression, safely (returns `None` on error).
-- [`griffelib.safe_get_expression`][]: Get an expression from an AST node, safely (returns `None` on error).
+- [`griffe.get_annotation`][]: Get a type annotation as expression.
+- [`griffe.get_base_class`][]: Get a base class as expression.
+- [`griffe.get_class_keyword`][]: Get a class keyword as expression.
+- [`griffe.get_condition`][]: Get a condition as expression.
+- [`griffe.get_expression`][]: Get an expression from an AST node.
+- [`griffe.safe_get_annotation`][]: Get a type annotation as expression, safely (returns `None` on error).
+- [`griffe.safe_get_base_class`][]: Get a base class as expression, safely (returns `None` on error).
+- [`griffe.safe_get_class_keyword`][]: Get a class keyword as expression, safely (returns `None` on error).
+- [`griffe.safe_get_condition`][]: Get a condition as expression, safely (returns `None` on error).
+- [`griffe.safe_get_expression`][]: Get an expression from an AST node, safely (returns `None` on error).
 
 The base class for expressions.
 
-- [`griffelib.Expr`][]
+- [`griffe.Expr`][]
 
 Expression classes all start with `Expr`.
 
@@ -147,19 +140,19 @@
 If you want to log messages from extensions, get a logger with `get_logger`.
 The `logger` attribute is used by Griffe itself. You can use it to temporarily disable Griffe logging.
 
-- [`griffelib.logger`][]: Our global logger, used throughout the library.
-- [`griffelib.get_logger`][]: Create and return a new logger instance.
+- [`griffe.logger`][]: Our global logger, used throughout the library.
+- [`griffe.get_logger`][]: Create and return a new logger instance.
 
 # Helpers
 
 To test your Griffe extensions, or to load API data from code in memory, Griffe provides the following helpers.
 
-- [`griffelib.temporary_pyfile`][]: Create a Python file containing the given code in a temporary directory.
-- [`griffelib.temporary_pypackage`][]: Create a package containing the given modules in a temporary directory.
-- [`griffelib.temporary_visited_module`][]: Create and visit a temporary module with the given code.
-- [`griffelib.temporary_visited_package`][]: Create and visit a temporary package.
-- [`griffelib.temporary_inspected_module`][]: Create and inspect a temporary module with the given code.
-- [`griffelib.temporary_inspected_package`][]: Create and inspect a temporary package.
+- [`griffe.temporary_pyfile`][]: Create a Python file containing the given code in a temporary directory.
+- [`griffe.temporary_pypackage`][]: Create a package containing the given modules in a temporary directory.
+- [`griffe.temporary_visited_module`][]: Create and visit a temporary module with the given code.
+- [`griffe.temporary_visited_package`][]: Create and visit a temporary package.
+- [`griffe.temporary_inspected_module`][]: Create and inspect a temporary module with the given code.
+- [`griffe.temporary_inspected_package`][]: Create and inspect a temporary package.
 """
 
 from __future__ import annotations
@@ -185,7 +178,6 @@
 from griffelib._internal.agents.nodes.values import get_value, safe_get_value
 from griffelib._internal.agents.visitor import Visitor, builtin_decorators, stdlib_decorators, typing_overload, visit
 from griffelib._internal.c3linear import c3linear_merge
-from griffecli._internal.cli import DEFAULT_LOG_LEVEL, check, dump, get_parser, main
 from griffelib._internal.collections import LinesCollection, ModulesCollection
 from griffelib._internal.diff import (
     AttributeChangedTypeBreakage,
@@ -383,7 +375,6 @@
 # names = sorted(n for n in dir(griffelib) if not n.startswith("_") and n not in ("annotations",))
 # print('__all__ = [\n    "' + '",\n    "'.join(names) + '",\n]')
 __all__ = [
-    "DEFAULT_LOG_LEVEL",
     "Alias",
     "AliasResolutionError",
     "Attribute",
@@ -546,9 +537,7 @@
     "builtin_decorators",
     "builtin_extensions",
     "c3linear_merge",
-    "check",
     "docstring_warning",
-    "dump",
     "dynamic_import",
     "find_breaking_changes",
     "get__all__",
@@ -563,7 +552,6 @@
     "get_name",
     "get_names",
     "get_parameters",
-    "get_parser",
     "get_value",
     "htree",
     "infer_docstring_style",
@@ -574,7 +562,6 @@
     "load_git",
     "load_pypi",
     "logger",
-    "main",
     "merge_stubs",
     "module_vtree",
     "parse",

packages/griffelib/src/griffelib/_internal/logger.py

@@ -4,7 +4,8 @@
 # For example, mkdocstrings-python patches the logger to relocate it as a child
 # of `mkdocs.plugins` so that it fits in the MkDocs logging configuration.
 #
-# We use a single, global logger because our public API is exposed in a single module, `griffelib`.
+# We use a single, global logger because our public API is exposed in a single module.
+# The logger name is "griffe" for backward compatibility.
 # Extensions however should use their own logger, which is why we provide the `get_logger` function.
 
 from __future__ import annotations
@@ -40,7 +41,7 @@ def disable(self) -> Iterator[None]:
             self._logger.setLevel(old_level)
 
     @classmethod
-    def _get(cls, name: str = "griffelib") -> Logger:
+    def _get(cls, name: str = "griffe") -> Logger:
         if name not in cls._instances:
             cls._instances[name] = cls(name)
         return cls._instances[name]
@@ -60,15 +61,15 @@ def _patch_loggers(cls, get_logger_func: Callable) -> None:
 
 Griffe's output and error messages are logging messages.
 
-Griffe provides the [`patch_loggers`][griffelib.patch_loggers]
+Griffe provides the [`patch_loggers`][griffe.patch_loggers]
 function so dependent libraries can patch Griffe loggers as they see fit.
 
 For example, to fit in the MkDocs logging configuration
 and prefix each log message with the module name:
 
 ```python
 import logging
-from griffelib import patch_loggers
+from griffe import patch_loggers
 
 
 class LoggerAdapter(logging.LoggerAdapter):
@@ -90,7 +91,7 @@ def get_logger(name):
 """
 
 
-def get_logger(name: str = "griffelib") -> Logger:
+def get_logger(name: str = "griffe") -> Logger:
     """Create and return a new logger instance.
 
     Parameters: