mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-08-28 05:25:04 +00:00
83bfddb4a4
* refactor(config): streamline job descriptions and parameter docs - Simplify descriptions for search, traverse, list, read, stat, frontmatter:read, write, edit, append, frontmatter:update, frontmatter:delete, move, delete, upload, upload_resource, and download jobs - Shorten parameter descriptions to be more concise - Maintain essential information while reducing verbosity refactor(steps): rename daily steps and consolidate functionality - Rename daily_resolve_step to daily_read_step - Rename daily_create_step to daily_write_step - Update __init__.py imports to reflect new step names - Consolidate daily operations documentation refactor(daily): extract helper functions and improve structure - Rename _day_index.py to _daily_io.py - Extract validate_slug function for Windows-safe filename validation - Move scan_notes function to public interface - Add comprehensive docstrings explaining slug validation and day-index rebuild concerns feat(daily): decouple list operation from index refresh - Remove automatic day index refresh from daily_list_step - Change daily_list_step to pure read operation with no side effects - Sort notes by slug for stable output - Update documentation to clarify read/write separation refactor(daily): remove deprecated create step - Remove unused daily/create.py module - Simplify daily operations to focus on CRUD patterns * refactor(daily): replace module imports with explicit step class imports
46 lines
2 KiB
Python
46 lines
2 KiB
Python
"""steps — registers every BaseStep subclass at import time.
|
|
|
|
Each submodule's ``@R.register`` decorators only fire when the module
|
|
is imported. Auto-importing them here means any config that names a
|
|
step backend (e.g. ``graph_traverse_step``, ``write``, ``digester``)
|
|
will find it in the registry without the caller having to remember
|
|
which submodule it lives in.
|
|
|
|
File-I/O is split by blast radius. The ``crud`` package covers both
|
|
opaque-byte ops (list / stat / move / delete / upload / download) and
|
|
whole-file text ops (read / write / append / edit) — they share the
|
|
same path-resolution helpers, so they live in one package.
|
|
``frontmatter`` is the one sliced surface that earns its own RUD
|
|
package (YAML is structured data — surgical key edits cannot be safely
|
|
emulated with string-substitution on the body). For mid-file body
|
|
edits, use ``edit`` (exact string replacement) or do a read + write
|
|
round-trip.
|
|
|
|
* ``common`` — search / health_check / help / reindex / version / graph_traverse
|
|
* ``crud`` — list / stat / move / delete / upload / download / read / write / append / edit
|
|
* ``frontmatter`` — markdown frontmatter slice RUD (frontmatter_read_step / update / delete)
|
|
* ``daily`` — note genesis / list / day-index reindex
|
|
* ``jobs`` — synchronizer / digester (LLM-driven orchestrators)
|
|
"""
|
|
|
|
from . import common # noqa: F401 -- registers common steps (search, version, graph_traverse, ...)
|
|
from . import crud # noqa: F401 -- registers list/stat/upload/download/move/delete/read/write/append/edit
|
|
from . import frontmatter # noqa: F401 -- registers frontmatter_read_step/update/delete
|
|
from . import (
|
|
daily,
|
|
) # noqa: F401 -- registers daily_read_step / daily_write_step / daily_list_step / daily_reindex_step
|
|
from . import background # noqa: F401
|
|
|
|
# from . import jobs # noqa: F401 -- registers synchronizer / digester
|
|
from .base_step import BaseStep
|
|
from . import graph # noqa: F401
|
|
|
|
__all__ = [
|
|
"background",
|
|
"common",
|
|
"crud",
|
|
"graph",
|
|
"frontmatter",
|
|
"daily",
|
|
"BaseStep",
|
|
]
|