feat: Expose public API as package imports

- Update usage documentation
cucumber · Jan 8, 2025 · b81ffd5 · b81ffd5
1 parent c5cf2b6
commit b81ffd5
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -133,11 +133,9 @@ func main() {
 #### Python
 
 ```python
-from gherkin.parser import Parser
-from gherkin.pickles.compiler import Compiler
+from gherkin import Compiler, Parser
 
-parser = Parser()
-gherkin_document = parser.parse("Feature: ...")
+gherkin_document = Parser().parse("Feature: ...")
 gherkin_document["uri"] = "uri_of_the_feature.feature"
 pickles = Compiler().compile(gherkin_document)
 ```

diff --git a/python/gherkin/__init__.py b/python/gherkin/__init__.py
@@ -0,0 +1,11 @@
+"""gherkin-official public API."""
+
+from __future__ import annotations
+
+from .parser import Parser
+from .pickles.compiler import Compiler
+
+__all__ = [
+    "Compiler",
+    "Parser",
+]