axonx 0.0.1__tar.gz

axonx-0.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 FlowLLM-AI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

axonx-0.0.1/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: axonx
+Version: 0.0.1
+Summary: An extensible, Pydantic-based framework for defining, discovering, and running ordered flows.
+Author-email: FlowLLM-AI <jinli.yl@alibaba-inc.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/FlowLLM-AI/Axon
+Project-URL: Issues, https://github.com/FlowLLM-AI/Axon/issues
+Project-URL: Repository, https://github.com/FlowLLM-AI/Axon
+Keywords: workflow,pipeline,automation,cli,pydantic,plugins
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: pydantic>=2.13.4
+Provides-Extra: dev
+Requires-Dist: build>=1.3.0; extra == "dev"
+Requires-Dist: coverage>=7.10.0; extra == "dev"
+Requires-Dist: pre-commit>=4.6.0; extra == "dev"
+Requires-Dist: pytest>=8.4.0; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/FlowLLM-AI/assets/main/axon/axon_logo.png" alt="Axon Logo" width="52%">
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/axonx/"><img src="https://img.shields.io/pypi/v/axonx" alt="PyPI"></a>
+  <a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.11%2B-blue" alt="Python 3.11+"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green" alt="Apache-2.0 License"></a>
+  <a href="README_ZH.md"><img src="https://img.shields.io/badge/README-中文-orange" alt="Chinese README"></a>
+</p>
+
+Axon is a small, extensible framework for defining, discovering, and running ordered flows. Each flow combines a
+strict Pydantic configuration, Python callables executed in order, a shared runtime context, and declared outputs.
+Applications install their flows as providers and expose them through the same `axon` command.
+
+The distribution is named `axonx`; the Python package and command are both named `axon`.
+
+## Framework at a glance
+
+| Layer | Contract | Responsibility |
+|---|---|---|
+| Configuration | `BaseConfig` | Validates typed inputs with unknown fields forbidden. |
+| Flow | `BaseFlow` | Owns configuration, logger, shared context, steps, and outputs. |
+| Step | `Callable[[], None]` | Performs one unit of work and reads or updates the flow context. |
+| Registry | `@register("name")` | Maps a normalized action name to one flow class. |
+| Discovery | `axon.flows` entry points | Imports installed provider modules so registration runs. |
+| Runtime | `axon --action --field value` | Parses inputs, validates configuration, executes steps, and emits JSON. |
+
+Axon deliberately keeps orchestration close to Python. A concrete list builds a fixed sequence; a generator can use
+normal `if`, `for`, and `yield from` control flow to decide later steps after earlier steps update the context. There is
+no separate workflow DSL or scheduler.
+
+## Installation
+
+Axon requires Python 3.11 or newer.
+
+```bash
+python -m pip install axonx
+```
+
+For framework development:
+
+```bash
+git clone https://github.com/FlowLLM-AI/Axon.git
+cd Axon/packages
+python -m pip install -e ".[dev]"
+```
+
+## Quick start
+
+The framework includes a small `demo` flow:
+
+```bash
+axon --list
+axon --demo --x 1 --y 2
+```
+
+The successful result is written to stdout as JSON:
+
+```json
+{"result": 3}
+```
+
+Every configuration argument is a `--field value` pair, including booleans. Hyphens in action and field names are
+normalized to underscores. Unknown fields, duplicate fields, missing values, malformed values, and unknown actions
+fail before flow execution.
+
+## Define a flow
+
+Subclass `BaseConfig` for inputs and `BaseFlow` for orchestration. Annotating `config` lets Axon infer the configuration
+class. `build_steps()` returns or yields zero-argument callables, while `output_keys` declares which context values
+must exist after execution.
+
+```python
+from collections.abc import Iterable
+
+from axon.cli import BaseConfig, BaseFlow, Step, register
+
+
+class GreetConfig(BaseConfig):
+    name: str
+    times: int = 1
+
+
+@register("greet")
+class GreetFlow(BaseFlow):
+    config: GreetConfig
+    output_keys = ("message",)
+
+    def build_steps(self) -> Iterable[Step]:
+        yield self.build_message
+
+    def build_message(self) -> None:
+        self.context["message"] = " ".join([f"hello {self.config.name}"] * self.config.times)
+```
+
+Import the module containing the class, then run:
+
+```bash
+axon --greet --name Axon --times 2
+```
+
+```json
+{"message": "hello Axon hello Axon"}
+```
+
+The execution contract is intentionally small:
+
+| Element | Rule |
+|---|---|
+| `config` annotation | Must resolve to a `BaseConfig` subclass. |
+| `build_steps()` | Returns an iterable of zero-argument callables in execution order. |
+| `self.context` | Starts with constructor keyword arguments and carries state between steps. |
+| `output_keys` | Names required context keys and preserves their declared order in the result. |
+| `execute()` | Runs every yielded step, then raises if any declared output is missing. |
+
+Dynamic orchestration uses ordinary Python:
+
+| Pattern | Expression |
+|---|---|
+| Task | `yield self.step` |
+| Sequence | `yield from self.build_subsequence()` |
+| Conditional | Use `if` while lazily yielding steps. |
+| For each | Loop and yield a zero-argument callable; use `functools.partial` to bind arguments. |
+
+Because a generator resumes between steps, conditions placed after a `yield` can observe context written by the
+previous step.
+
+## Publish a flow provider
+
+An external package exposes its flows through the `axon.flows` entry-point group. For example, this repository's
+[`pyproject.toml`](../pyproject.toml) connects `axon-core` to the framework with:
+
+```toml
+[project.entry-points."axon.flows"]
+default = "core.default"
+```
+
+Axon imports `core.default`, whose package initialization imports the modules containing `@register(...)`. After the
+provider is installed, its flows appear automatically:
+
+```bash
+axon --list
+```
+
+## Built-in flows
+
+This table describes flows shipped by `axonx`. Provider packages should document their own flows in the same format,
+making the catalog easy to extend as new flows are added.
+
+| Flow | Config | Inputs | Output | Purpose |
+|---|---|---|---|---|
+| `demo` | `DemoConfig` | `x: int`, `y: int` | `result` | Demonstrates task, sequence, conditional, and loop-based step generation by adding two integers. |
+
+## Utilities
+
+The supported helpers are exported from `axon.utils`. Add one row when a new public utility is introduced so this
+table remains the compact public catalog.
+
+| Utility | Signature | Configuration | Behavior |
+|---|---|---|---|
+| `load_env` | `load_env(path=None, *, override=True) -> dict[str, str]` | Optional file path | Loads an explicit file or the nearest `.env` in the working directory or first five parents. Returns only values written to the environment. |
+| `get_logger` | `get_logger()` | `AXON_LOG_DIR` | Lazily creates the shared Loguru INFO logger with stderr and daily rotating file sinks; file retention is seven days. |
+| `send_dingtalk_message` | `send_dingtalk_message(title, text, msgtype="markdown", timeout=10.0) -> str` | `DINGTALK_CLIENT_ID`, `DINGTALK_CLIENT_SECRET`, `DINGTALK_CONVERSATIONS` | Sends Markdown or text through a DingTalk application robot to every configured, deduplicated conversation. |
+
+`DINGTALK_CONVERSATIONS` must be a JSON object whose non-empty names map to non-empty conversation IDs, for example
+`{"research":"cidxxx","operations":"cidyyy"}`. Credentials and group IDs are omitted from transport errors. Network
+calls occur only when `send_dingtalk_message()` is invoked.
+
+## Environment variables
+
+Axon calls `load_env()` before CLI provider discovery, allowing provider imports to resolve environment-based defaults.
+
+| Variable | Used by | Default | Purpose |
+|---|---|---|---|
+| `AXON_LOG_DIR` | Shared logger | `logs` | Directory for timestamped process log files. |
+| `DINGTALK_CLIENT_ID` | DingTalk helper | Required on use | Application key and robot code. |
+| `DINGTALK_CLIENT_SECRET` | DingTalk helper | Required on use | Application secret used to obtain an access token. |
+| `DINGTALK_CONVERSATIONS` | DingTalk helper | Required on use | JSON object mapping names to group conversation IDs. |
+
+Provider-specific variables belong in the provider's documentation rather than the framework package.
+
+## Package layout
+
+| Path | Contents |
+|---|---|
+| `axon/cli.py` | Configuration and flow bases, registry, provider discovery, argument parsing, execution, and CLI. |
+| `axon/flows/` | Built-in flows; importing the package registers them. |
+| `axon/utils/` | Environment, logging, and notification helpers. |
+| `tests/` | Fast tests using temporary files and mocked network boundaries. |
+
+## Development
+
+```bash
+python -m pytest -v --tb=long
+pre-commit run --all-files
+python -m build
+```
+
+Keep provider-specific business logic outside the framework. A provider may depend on `axonx`; `axonx` must not
+depend on that provider.
+
+## License
+
+Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for details.

axonx-0.0.1/README.md

@@ -0,0 +1,205 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/FlowLLM-AI/assets/main/axon/axon_logo.png" alt="Axon Logo" width="52%">
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/axonx/"><img src="https://img.shields.io/pypi/v/axonx" alt="PyPI"></a>
+  <a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.11%2B-blue" alt="Python 3.11+"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green" alt="Apache-2.0 License"></a>
+  <a href="README_ZH.md"><img src="https://img.shields.io/badge/README-中文-orange" alt="Chinese README"></a>
+</p>
+
+Axon is a small, extensible framework for defining, discovering, and running ordered flows. Each flow combines a
+strict Pydantic configuration, Python callables executed in order, a shared runtime context, and declared outputs.
+Applications install their flows as providers and expose them through the same `axon` command.
+
+The distribution is named `axonx`; the Python package and command are both named `axon`.
+
+## Framework at a glance
+
+| Layer | Contract | Responsibility |
+|---|---|---|
+| Configuration | `BaseConfig` | Validates typed inputs with unknown fields forbidden. |
+| Flow | `BaseFlow` | Owns configuration, logger, shared context, steps, and outputs. |
+| Step | `Callable[[], None]` | Performs one unit of work and reads or updates the flow context. |
+| Registry | `@register("name")` | Maps a normalized action name to one flow class. |
+| Discovery | `axon.flows` entry points | Imports installed provider modules so registration runs. |
+| Runtime | `axon --action --field value` | Parses inputs, validates configuration, executes steps, and emits JSON. |
+
+Axon deliberately keeps orchestration close to Python. A concrete list builds a fixed sequence; a generator can use
+normal `if`, `for`, and `yield from` control flow to decide later steps after earlier steps update the context. There is
+no separate workflow DSL or scheduler.
+
+## Installation
+
+Axon requires Python 3.11 or newer.
+
+```bash
+python -m pip install axonx
+```
+
+For framework development:
+
+```bash
+git clone https://github.com/FlowLLM-AI/Axon.git
+cd Axon/packages
+python -m pip install -e ".[dev]"
+```
+
+## Quick start
+
+The framework includes a small `demo` flow:
+
+```bash
+axon --list
+axon --demo --x 1 --y 2
+```
+
+The successful result is written to stdout as JSON:
+
+```json
+{"result": 3}
+```
+
+Every configuration argument is a `--field value` pair, including booleans. Hyphens in action and field names are
+normalized to underscores. Unknown fields, duplicate fields, missing values, malformed values, and unknown actions
+fail before flow execution.
+
+## Define a flow
+
+Subclass `BaseConfig` for inputs and `BaseFlow` for orchestration. Annotating `config` lets Axon infer the configuration
+class. `build_steps()` returns or yields zero-argument callables, while `output_keys` declares which context values
+must exist after execution.
+
+```python
+from collections.abc import Iterable
+
+from axon.cli import BaseConfig, BaseFlow, Step, register
+
+
+class GreetConfig(BaseConfig):
+    name: str
+    times: int = 1
+
+
+@register("greet")
+class GreetFlow(BaseFlow):
+    config: GreetConfig
+    output_keys = ("message",)
+
+    def build_steps(self) -> Iterable[Step]:
+        yield self.build_message
+
+    def build_message(self) -> None:
+        self.context["message"] = " ".join([f"hello {self.config.name}"] * self.config.times)
+```
+
+Import the module containing the class, then run:
+
+```bash
+axon --greet --name Axon --times 2
+```
+
+```json
+{"message": "hello Axon hello Axon"}
+```
+
+The execution contract is intentionally small:
+
+| Element | Rule |
+|---|---|
+| `config` annotation | Must resolve to a `BaseConfig` subclass. |
+| `build_steps()` | Returns an iterable of zero-argument callables in execution order. |
+| `self.context` | Starts with constructor keyword arguments and carries state between steps. |
+| `output_keys` | Names required context keys and preserves their declared order in the result. |
+| `execute()` | Runs every yielded step, then raises if any declared output is missing. |
+
+Dynamic orchestration uses ordinary Python:
+
+| Pattern | Expression |
+|---|---|
+| Task | `yield self.step` |
+| Sequence | `yield from self.build_subsequence()` |
+| Conditional | Use `if` while lazily yielding steps. |
+| For each | Loop and yield a zero-argument callable; use `functools.partial` to bind arguments. |
+
+Because a generator resumes between steps, conditions placed after a `yield` can observe context written by the
+previous step.
+
+## Publish a flow provider
+
+An external package exposes its flows through the `axon.flows` entry-point group. For example, this repository's
+[`pyproject.toml`](../pyproject.toml) connects `axon-core` to the framework with:
+
+```toml
+[project.entry-points."axon.flows"]
+default = "core.default"
+```
+
+Axon imports `core.default`, whose package initialization imports the modules containing `@register(...)`. After the
+provider is installed, its flows appear automatically:
+
+```bash
+axon --list
+```
+
+## Built-in flows
+
+This table describes flows shipped by `axonx`. Provider packages should document their own flows in the same format,
+making the catalog easy to extend as new flows are added.
+
+| Flow | Config | Inputs | Output | Purpose |
+|---|---|---|---|---|
+| `demo` | `DemoConfig` | `x: int`, `y: int` | `result` | Demonstrates task, sequence, conditional, and loop-based step generation by adding two integers. |
+
+## Utilities
+
+The supported helpers are exported from `axon.utils`. Add one row when a new public utility is introduced so this
+table remains the compact public catalog.
+
+| Utility | Signature | Configuration | Behavior |
+|---|---|---|---|
+| `load_env` | `load_env(path=None, *, override=True) -> dict[str, str]` | Optional file path | Loads an explicit file or the nearest `.env` in the working directory or first five parents. Returns only values written to the environment. |
+| `get_logger` | `get_logger()` | `AXON_LOG_DIR` | Lazily creates the shared Loguru INFO logger with stderr and daily rotating file sinks; file retention is seven days. |
+| `send_dingtalk_message` | `send_dingtalk_message(title, text, msgtype="markdown", timeout=10.0) -> str` | `DINGTALK_CLIENT_ID`, `DINGTALK_CLIENT_SECRET`, `DINGTALK_CONVERSATIONS` | Sends Markdown or text through a DingTalk application robot to every configured, deduplicated conversation. |
+
+`DINGTALK_CONVERSATIONS` must be a JSON object whose non-empty names map to non-empty conversation IDs, for example
+`{"research":"cidxxx","operations":"cidyyy"}`. Credentials and group IDs are omitted from transport errors. Network
+calls occur only when `send_dingtalk_message()` is invoked.
+
+## Environment variables
+
+Axon calls `load_env()` before CLI provider discovery, allowing provider imports to resolve environment-based defaults.
+
+| Variable | Used by | Default | Purpose |
+|---|---|---|---|
+| `AXON_LOG_DIR` | Shared logger | `logs` | Directory for timestamped process log files. |
+| `DINGTALK_CLIENT_ID` | DingTalk helper | Required on use | Application key and robot code. |
+| `DINGTALK_CLIENT_SECRET` | DingTalk helper | Required on use | Application secret used to obtain an access token. |
+| `DINGTALK_CONVERSATIONS` | DingTalk helper | Required on use | JSON object mapping names to group conversation IDs. |
+
+Provider-specific variables belong in the provider's documentation rather than the framework package.
+
+## Package layout
+
+| Path | Contents |
+|---|---|
+| `axon/cli.py` | Configuration and flow bases, registry, provider discovery, argument parsing, execution, and CLI. |
+| `axon/flows/` | Built-in flows; importing the package registers them. |
+| `axon/utils/` | Environment, logging, and notification helpers. |
+| `tests/` | Fast tests using temporary files and mocked network boundaries. |
+
+## Development
+
+```bash
+python -m pytest -v --tb=long
+pre-commit run --all-files
+python -m build
+```
+
+Keep provider-specific business logic outside the framework. A provider may depend on `axonx`; `axonx` must not
+depend on that provider.
+
+## License
+
+Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for details.

axonx-0.0.1/axon/__init__.py

@@ -0,0 +1,7 @@
+"""Axon lightweight flow framework."""
+
+from . import cli, flows, utils
+
+__version__ = "0.0.1"
+
+__all__ = ["__version__", "cli", "flows", "utils"]