roadmap-core 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,21 @@
1
+ """The roadmap graph, store and CLI, as a standalone package.
2
+
3
+ Import the graph explicitly rather than re-exporting it here::
4
+
5
+ from roadmap_core import graph
6
+ from roadmap_core.graph import derive_status, validate_graph
7
+
8
+ Kept bare on purpose, for a reason that outlived the one it was written for.
9
+ It used to be that ``scripts/roadmap.py`` loaded ``graph.py`` *by path* with
10
+ nothing installed, and a package ``__init__`` importing submodules would have
11
+ broken that. The CLI lives in here now (``roadmap_core.cli``) and imports its
12
+ siblings normally, so that particular hazard is gone.
13
+
14
+ What remains is better: ``graph``, ``store`` and ``stores`` are importable with
15
+ no third-party package present at all, and ``cli`` is importable without
16
+ PyYAML — it imports it inside the two functions that parse item files. A
17
+ ``__init__`` that reached for ``cli`` would drag that requirement onto every
18
+ caller of the graph, including the Lucille backend, which needs none of it.
19
+ ``roadmap-core-tests.yml`` asserts exactly this by running the suite in an
20
+ environment where ``yaml`` cannot be imported at all.
21
+ """