everalgo-knowledge 0.1.0__tar.gz

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,58 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # Distribution / packaging
7
+ build/
8
+ dist/
9
+ *.egg-info/
10
+ *.egg
11
+ wheels/
12
+
13
+ # Environments
14
+ .env
15
+ .env.local
16
+ .venv
17
+ env/
18
+ venv/
19
+
20
+ # uv
21
+ .uv/
22
+
23
+ # Test / coverage / cache
24
+ .pytest_cache/
25
+ .cache
26
+ .coverage
27
+ .coverage.*
28
+ coverage.xml
29
+ report.xml
30
+ htmlcov/
31
+ .tox/
32
+ .nox/
33
+ .hypothesis/
34
+
35
+ # Type checkers / linters
36
+ .mypy_cache/
37
+ .dmypy.json
38
+ .pyre/
39
+ .pytype/
40
+ .ruff_cache/
41
+
42
+ # Jupyter
43
+ .ipynb_checkpoints/
44
+
45
+ # IDE / OS
46
+ .vscode/
47
+ .idea/
48
+ *.swp
49
+ .DS_Store
50
+
51
+ # Logs
52
+ *.log
53
+
54
+ # Project local artifacts (placed under local/ per project convention)
55
+ local/
56
+
57
+ # Claude Code session-local state (scheduled tasks, agent caches, locks)
58
+ .claude/
@@ -0,0 +1,13 @@
1
+ # Changelog
2
+
3
+ All notable changes to this package are documented here. Format follows
4
+ [Keep a Changelog 1.1.0](https://keepachangelog.com/en/1.1.0/). Versioning
5
+ follows [Semantic Versioning 2.0](https://semver.org/spec/v2.0.0.html).
6
+
7
+ ## [Unreleased]
8
+
9
+ ### Added
10
+
11
+ - `KnowledgeExtractor` stub; public API surface is frozen, implementation is pending.
12
+
13
+ [Unreleased]: https://github.com/EverMind-AI/EverAlgo/compare/main...HEAD
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 EverMind
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,46 @@
1
+ Metadata-Version: 2.4
2
+ Name: everalgo-knowledge
3
+ Version: 0.1.0
4
+ Summary: EverAlgo knowledge: file-based knowledge extractors producing KnowledgeMemory.
5
+ Project-URL: Homepage, https://github.com/EverMind-AI/EverAlgo
6
+ Project-URL: Repository, https://github.com/EverMind-AI/EverAlgo
7
+ Project-URL: Issues, https://github.com/EverMind-AI/EverAlgo/issues
8
+ Project-URL: Documentation, https://github.com/EverMind-AI/EverAlgo/tree/main/packages/everalgo-knowledge
9
+ Project-URL: Changelog, https://github.com/EverMind-AI/EverAlgo/blob/main/packages/everalgo-knowledge/CHANGELOG.md
10
+ Author: EverMind
11
+ License-Expression: MIT
12
+ License-File: LICENSE
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: License :: OSI Approved :: MIT License
15
+ Classifier: Programming Language :: Python :: 3.12
16
+ Requires-Python: >=3.12
17
+ Requires-Dist: everalgo-core<2.0.0,>=0.1.0
18
+ Requires-Dist: everalgo-parser<2.0.0,>=0.1.0
19
+ Description-Content-Type: text/markdown
20
+
21
+ # everalgo-knowledge
22
+
23
+ > [!WARNING]
24
+ > **NOT YET IMPLEMENTED — placeholder distribution.** All entry points raise `NotImplementedError`. The `everalgo.knowledge` namespace is reserved on PyPI. Track progress in [`docs/concepts/architecture.md`](../../docs/concepts/architecture.md).
25
+
26
+ File-based knowledge extractors for EverAlgo — turns parsed multimodal content (`ParsedContent`) into `KnowledgeMemory` records.
27
+
28
+ See the umbrella project: [EverAlgo monorepo](../../README.md) and the architecture document at [`docs/concepts/architecture.md`](../../docs/concepts/architecture.md).
29
+
30
+ ## Install
31
+
32
+ ```bash
33
+ pip install everalgo-knowledge
34
+ # Auto-pulls: everalgo-core, everalgo-parser
35
+ ```
36
+
37
+ ## Public surface (stubbed)
38
+
39
+ | Symbol | Module | Role |
40
+ |---|---|---|
41
+ | `KnowledgeExtractor` | `everalgo.knowledge` | Stub — raises `NotImplementedError` |
42
+
43
+ ## Related distributions
44
+
45
+ - [`everalgo-parser`](../everalgo-parser/) — produces `ParsedContent` from raw files; also experimental
46
+ - [`everalgo-core`](../everalgo-core/) — `KnowledgeMemory` type is defined here
@@ -0,0 +1,26 @@
1
+ # everalgo-knowledge
2
+
3
+ > [!WARNING]
4
+ > **NOT YET IMPLEMENTED — placeholder distribution.** All entry points raise `NotImplementedError`. The `everalgo.knowledge` namespace is reserved on PyPI. Track progress in [`docs/concepts/architecture.md`](../../docs/concepts/architecture.md).
5
+
6
+ File-based knowledge extractors for EverAlgo — turns parsed multimodal content (`ParsedContent`) into `KnowledgeMemory` records.
7
+
8
+ See the umbrella project: [EverAlgo monorepo](../../README.md) and the architecture document at [`docs/concepts/architecture.md`](../../docs/concepts/architecture.md).
9
+
10
+ ## Install
11
+
12
+ ```bash
13
+ pip install everalgo-knowledge
14
+ # Auto-pulls: everalgo-core, everalgo-parser
15
+ ```
16
+
17
+ ## Public surface (stubbed)
18
+
19
+ | Symbol | Module | Role |
20
+ |---|---|---|
21
+ | `KnowledgeExtractor` | `everalgo.knowledge` | Stub — raises `NotImplementedError` |
22
+
23
+ ## Related distributions
24
+
25
+ - [`everalgo-parser`](../everalgo-parser/) — produces `ParsedContent` from raw files; also experimental
26
+ - [`everalgo-core`](../everalgo-core/) — `KnowledgeMemory` type is defined here
@@ -0,0 +1,31 @@
1
+ [build-system]
2
+ requires = ["hatchling"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "everalgo-knowledge"
7
+ version = "0.1.0"
8
+ description = "EverAlgo knowledge: file-based knowledge extractors producing KnowledgeMemory."
9
+ requires-python = ">=3.12"
10
+ license = "MIT"
11
+ readme = "README.md"
12
+ authors = [{ name = "EverMind" }]
13
+ classifiers = [
14
+ "Development Status :: 3 - Alpha",
15
+ "License :: OSI Approved :: MIT License",
16
+ "Programming Language :: Python :: 3.12",
17
+ ]
18
+ dependencies = [
19
+ "everalgo-core>=0.1.0,<2.0.0",
20
+ "everalgo-parser>=0.1.0,<2.0.0",
21
+ ]
22
+
23
+ [project.urls]
24
+ Homepage = "https://github.com/EverMind-AI/EverAlgo"
25
+ Repository = "https://github.com/EverMind-AI/EverAlgo"
26
+ Issues = "https://github.com/EverMind-AI/EverAlgo/issues"
27
+ Documentation = "https://github.com/EverMind-AI/EverAlgo/tree/main/packages/everalgo-knowledge"
28
+ Changelog = "https://github.com/EverMind-AI/EverAlgo/blob/main/packages/everalgo-knowledge/CHANGELOG.md"
29
+
30
+ [tool.hatch.build.targets.wheel]
31
+ packages = ["src/everalgo"]
@@ -0,0 +1,10 @@
1
+ """File-based knowledge extraction — KnowledgeExtractor stub."""
2
+
3
+ import logging
4
+
5
+ from everalgo.knowledge.extractor import KnowledgeExtractor
6
+
7
+ __all__ = ["KnowledgeExtractor"]
8
+
9
+ # Library logging setup (ADR-013): NullHandler on each subpackage logger.
10
+ logging.getLogger(__name__).addHandler(logging.NullHandler())
@@ -0,0 +1,40 @@
1
+ """KnowledgeExtractor — ParsedContent → list[KnowledgeMemory]. Stub."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing import TYPE_CHECKING
6
+
7
+ if TYPE_CHECKING:
8
+ from everalgo.llm.protocols import LLMClient
9
+ from everalgo.types import KnowledgeMemory, ParsedContent
10
+
11
+
12
+ class KnowledgeExtractor:
13
+ """Extract knowledge memories from parsed content. Stub."""
14
+
15
+ def __init__(self, *, llm: LLMClient) -> None:
16
+ self._llm = llm
17
+
18
+ async def aextract(
19
+ self,
20
+ parsed: ParsedContent,
21
+ *,
22
+ prompt: str | None = None,
23
+ ) -> list[KnowledgeMemory]:
24
+ """EXPERIMENTAL: NOT YET IMPLEMENTED — raises NotImplementedError.
25
+
26
+ Stub: returns placeholder.
27
+ """
28
+ raise NotImplementedError("stub")
29
+
30
+ def extract(
31
+ self,
32
+ parsed: ParsedContent,
33
+ *,
34
+ prompt: str | None = None,
35
+ ) -> list[KnowledgeMemory]:
36
+ """EXPERIMENTAL: NOT YET IMPLEMENTED — raises NotImplementedError.
37
+
38
+ Stub: returns placeholder.
39
+ """
40
+ raise NotImplementedError("stub")
File without changes
@@ -0,0 +1,22 @@
1
+ """Tests for everalgo.knowledge package-level public API."""
2
+
3
+ import everalgo.knowledge
4
+ from everalgo.testing.fake_llm import FakeLLMClient
5
+
6
+
7
+ def test_knowledge_extractor_exported() -> None:
8
+ """Knowledge exposes KnowledgeExtractor at top level."""
9
+ assert hasattr(everalgo.knowledge, "KnowledgeExtractor")
10
+
11
+
12
+ def test_dunder_all_lists_one_symbol() -> None:
13
+ """__all__ exposes exactly KnowledgeExtractor."""
14
+ assert everalgo.knowledge.__all__ == ["KnowledgeExtractor"]
15
+
16
+
17
+ def test_extractor_instantiable_with_llm() -> None:
18
+ """KnowledgeExtractor accepts a required llm= keyword argument at construction."""
19
+ from everalgo.knowledge import KnowledgeExtractor
20
+
21
+ fake = FakeLLMClient(responses=[])
22
+ assert KnowledgeExtractor(llm=fake).__class__.__name__ == "KnowledgeExtractor"