whytrend 0.1.0__tar.gz

whytrend-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Ruff
+        run: ruff check src tests examples
+
+      - name: Mypy
+        run: mypy src/whytrend
+
+      - name: Pytest
+        run: pytest

whytrend-0.1.0/.gitignore

@@ -0,0 +1,34 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+.eggs/
+dist/
+build/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Tooling
+uv.lock
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+
+# Environment & secrets
+.env
+.env.*
+
+# OS
+.DS_Store

whytrend-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 Alexander Provatorov
+
+   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.

whytrend-0.1.0/NOTICE

@@ -0,0 +1,7 @@
+WhyTrend
+Copyright 2026 Alexander Provatorov
+
+Created and maintained by Alexander Provatorov (https://github.com/AlexProvatorov).
+
+Licensed under the Apache License, Version 2.0.
+See the LICENSE file for the full license text.

whytrend-0.1.0/PKG-INFO

@@ -0,0 +1,226 @@
+Metadata-Version: 2.4
+Name: whytrend
+Version: 0.1.0
+Summary: Open Source Framework for Explainable Time Series Analysis
+Project-URL: Homepage, https://github.com/AlexProvatorov/WhyTrend
+Project-URL: Documentation, https://github.com/AlexProvatorov/WhyTrend#readme
+Project-URL: Repository, https://github.com/AlexProvatorov/WhyTrend
+Project-URL: Issues, https://github.com/AlexProvatorov/WhyTrend/issues
+Author-email: Alexander Provatorov <sasha.provatorov@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: anomaly-detection,changepoint,explainability,llm,time-series
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: pandas>=2.0
+Requires-Dist: pydantic>=2.0
+Provides-Extra: all
+Requires-Dist: openai>=1.0; extra == 'all'
+Requires-Dist: prophet>=1.1; extra == 'all'
+Requires-Dist: pyarrow>=15.0; extra == 'all'
+Requires-Dist: pytrends>=4.9; extra == 'all'
+Requires-Dist: ruptures>=1.1; extra == 'all'
+Requires-Dist: sentence-transformers>=3.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.13; extra == 'dev'
+Requires-Dist: pandas-stubs>=2.0; extra == 'dev'
+Requires-Dist: pyarrow>=15.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: pytrends>=4.9; extra == 'dev'
+Requires-Dist: ruff>=0.8; extra == 'dev'
+Provides-Extra: openai
+Requires-Dist: openai>=1.0; extra == 'openai'
+Provides-Extra: parquet
+Requires-Dist: pyarrow>=15.0; extra == 'parquet'
+Provides-Extra: prophet
+Requires-Dist: prophet>=1.1; extra == 'prophet'
+Provides-Extra: ranking
+Requires-Dist: sentence-transformers>=3.0; extra == 'ranking'
+Provides-Extra: ruptures
+Requires-Dist: ruptures>=1.1; extra == 'ruptures'
+Provides-Extra: trends
+Requires-Dist: pytrends>=4.9; extra == 'trends'
+Description-Content-Type: text/markdown
+
+# WhyTrend
+
+[![CI](https://github.com/AlexProvatorov/WhyTrend/actions/workflows/ci.yml/badge.svg)](https://github.com/AlexProvatorov/WhyTrend/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/whytrend.svg)](https://pypi.org/project/whytrend/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/downloads/)
+
+**Open Source Framework for Explainable Time Series Analysis**
+
+WhyTrend detects anomalies, change points, and trend shifts in time series — then automatically explains *why* they happened using external context and LLMs.
+
+If this project is useful to you, consider giving it a **star** on GitHub — it helps others discover the project. Forks and pull requests are welcome.
+
+## Features
+
+- Fluent `Pipeline` API for source → detection → collection → ranking → explanation
+- Pluggable sources, detectors, collectors, rankers, and LLM providers
+- Structured `Report` output (JSON and Markdown)
+- Async collectors and LLM calls
+- Works offline with `MockLLMProvider` and local models via `OllamaExplainer`
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install whytrend
+```
+
+### Optional extras
+
+```bash
+pip install "whytrend[openai]"      # OpenAI API
+pip install "whytrend[trends]"      # Google Trends
+pip install "whytrend[prophet]"     # Prophet detector
+pip install "whytrend[ranking]"     # Embedding ranker
+pip install "whytrend[all]"           # everything
+```
+
+### From source (development)
+
+```bash
+git clone https://github.com/AlexProvatorov/WhyTrend.git
+cd WhyTrend
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Quickstart (CSV, no API keys)
+
+```python
+from whytrend import (
+    BM25Ranker,
+    CSVSource,
+    LLMExplainer,
+    MockLLMProvider,
+    Pipeline,
+    ZScoreDetector,
+)
+
+pipeline = (
+    Pipeline(window_days=3)
+    .add_source(CSVSource("your_series.csv", keyword="Python"))
+    .add_detector(ZScoreDetector(threshold=1.0))
+    .add_ranker(BM25Ranker(top_k=5))
+    .add_explainer(LLMExplainer(MockLLMProvider()))
+)
+
+report = pipeline.run()
+print(report.executive_summary)
+print(report.to_markdown())
+```
+
+CSV must have `timestamp` and `value` columns. When developing from a clone, you can use
+`tests/fixtures/python_interest.csv` as sample data.
+
+Run the full demo (requires a repository clone):
+
+```bash
+git clone https://github.com/AlexProvatorov/WhyTrend.git
+cd WhyTrend
+pip install -e ".[dev]"
+python examples/mvp_demo.py
+```
+
+## Production-style example
+
+```python
+from whytrend import (
+    GoogleTrends,
+    OpenAIExplainer,
+    Pipeline,
+    ProphetDetector,
+)
+from whytrend.collectors import HackerNewsCollector, WikipediaCollector
+from whytrend.rankers import BM25Ranker
+
+pipeline = (
+    Pipeline()
+    .add_source(GoogleTrends("Python"))
+    .add_detector(ProphetDetector())
+    .add_collector(HackerNewsCollector())
+    .add_collector(WikipediaCollector())
+    .add_ranker(BM25Ranker())
+    .add_explainer(OpenAIExplainer())  # OPENAI_API_KEY env var or api_key="..."
+)
+
+report = pipeline.run()
+print(report.executive_summary)
+```
+
+Use `OllamaExplainer(model="llama3.2")` for a local LLM instead of OpenAI.
+
+For OpenAI, pass a key explicitly or set the environment variable:
+
+```python
+OpenAIExplainer(api_key="sk-...")
+# or: export OPENAI_API_KEY=sk-...
+```
+
+## Architecture
+
+```
+Source → Detector → Event Builder → Collectors → Ranker → Explainer → Report
+```
+
+## Roadmap
+
+Core MVP is in place. Next focus: **integrations and ecosystem**.
+
+### v0.2 — More collectors
+- [ ] Google News
+- [ ] Reddit
+- [ ] GitHub Releases
+- [ ] RSS / Stack Overflow
+
+### v0.3 — More detectors
+- [ ] Ruptures (change-point)
+- [ ] River / streaming detectors
+
+### v0.4 — More LLM providers
+- [ ] Anthropic, Gemini, DeepSeek
+- [ ] Azure OpenAI, OpenRouter
+
+### v0.5 — Reports and DX
+- [ ] HTML / PDF reports
+- [ ] CLI (`whytrend analyze ...`)
+- [ ] Plugin registry (entry points)
+
+Track progress in [GitHub Issues](https://github.com/AlexProvatorov/WhyTrend/issues).
+
+## Development
+
+Requires a repository clone:
+
+```bash
+git clone https://github.com/AlexProvatorov/WhyTrend.git
+cd WhyTrend
+pip install -e ".[dev]"
+ruff check src tests
+mypy src/whytrend
+pytest
+```
+
+## Author
+
+**Alexander Provatorov** — [GitHub @AlexProvatorov](https://github.com/AlexProvatorov)
+
+## License
+
+Licensed under the [Apache License, Version 2.0](LICENSE).

whytrend-0.1.0/README.md

@@ -0,0 +1,172 @@
+# WhyTrend
+
+[![CI](https://github.com/AlexProvatorov/WhyTrend/actions/workflows/ci.yml/badge.svg)](https://github.com/AlexProvatorov/WhyTrend/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/whytrend.svg)](https://pypi.org/project/whytrend/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/downloads/)
+
+**Open Source Framework for Explainable Time Series Analysis**
+
+WhyTrend detects anomalies, change points, and trend shifts in time series — then automatically explains *why* they happened using external context and LLMs.
+
+If this project is useful to you, consider giving it a **star** on GitHub — it helps others discover the project. Forks and pull requests are welcome.
+
+## Features
+
+- Fluent `Pipeline` API for source → detection → collection → ranking → explanation
+- Pluggable sources, detectors, collectors, rankers, and LLM providers
+- Structured `Report` output (JSON and Markdown)
+- Async collectors and LLM calls
+- Works offline with `MockLLMProvider` and local models via `OllamaExplainer`
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install whytrend
+```
+
+### Optional extras
+
+```bash
+pip install "whytrend[openai]"      # OpenAI API
+pip install "whytrend[trends]"      # Google Trends
+pip install "whytrend[prophet]"     # Prophet detector
+pip install "whytrend[ranking]"     # Embedding ranker
+pip install "whytrend[all]"           # everything
+```
+
+### From source (development)
+
+```bash
+git clone https://github.com/AlexProvatorov/WhyTrend.git
+cd WhyTrend
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Quickstart (CSV, no API keys)
+
+```python
+from whytrend import (
+    BM25Ranker,
+    CSVSource,
+    LLMExplainer,
+    MockLLMProvider,
+    Pipeline,
+    ZScoreDetector,
+)
+
+pipeline = (
+    Pipeline(window_days=3)
+    .add_source(CSVSource("your_series.csv", keyword="Python"))
+    .add_detector(ZScoreDetector(threshold=1.0))
+    .add_ranker(BM25Ranker(top_k=5))
+    .add_explainer(LLMExplainer(MockLLMProvider()))
+)
+
+report = pipeline.run()
+print(report.executive_summary)
+print(report.to_markdown())
+```
+
+CSV must have `timestamp` and `value` columns. When developing from a clone, you can use
+`tests/fixtures/python_interest.csv` as sample data.
+
+Run the full demo (requires a repository clone):
+
+```bash
+git clone https://github.com/AlexProvatorov/WhyTrend.git
+cd WhyTrend
+pip install -e ".[dev]"
+python examples/mvp_demo.py
+```
+
+## Production-style example
+
+```python
+from whytrend import (
+    GoogleTrends,
+    OpenAIExplainer,
+    Pipeline,
+    ProphetDetector,
+)
+from whytrend.collectors import HackerNewsCollector, WikipediaCollector
+from whytrend.rankers import BM25Ranker
+
+pipeline = (
+    Pipeline()
+    .add_source(GoogleTrends("Python"))
+    .add_detector(ProphetDetector())
+    .add_collector(HackerNewsCollector())
+    .add_collector(WikipediaCollector())
+    .add_ranker(BM25Ranker())
+    .add_explainer(OpenAIExplainer())  # OPENAI_API_KEY env var or api_key="..."
+)
+
+report = pipeline.run()
+print(report.executive_summary)
+```
+
+Use `OllamaExplainer(model="llama3.2")` for a local LLM instead of OpenAI.
+
+For OpenAI, pass a key explicitly or set the environment variable:
+
+```python
+OpenAIExplainer(api_key="sk-...")
+# or: export OPENAI_API_KEY=sk-...
+```
+
+## Architecture
+
+```
+Source → Detector → Event Builder → Collectors → Ranker → Explainer → Report
+```
+
+## Roadmap
+
+Core MVP is in place. Next focus: **integrations and ecosystem**.
+
+### v0.2 — More collectors
+- [ ] Google News
+- [ ] Reddit
+- [ ] GitHub Releases
+- [ ] RSS / Stack Overflow
+
+### v0.3 — More detectors
+- [ ] Ruptures (change-point)
+- [ ] River / streaming detectors
+
+### v0.4 — More LLM providers
+- [ ] Anthropic, Gemini, DeepSeek
+- [ ] Azure OpenAI, OpenRouter
+
+### v0.5 — Reports and DX
+- [ ] HTML / PDF reports
+- [ ] CLI (`whytrend analyze ...`)
+- [ ] Plugin registry (entry points)
+
+Track progress in [GitHub Issues](https://github.com/AlexProvatorov/WhyTrend/issues).
+
+## Development
+
+Requires a repository clone:
+
+```bash
+git clone https://github.com/AlexProvatorov/WhyTrend.git
+cd WhyTrend
+pip install -e ".[dev]"
+ruff check src tests
+mypy src/whytrend
+pytest
+```
+
+## Author
+
+**Alexander Provatorov** — [GitHub @AlexProvatorov](https://github.com/AlexProvatorov)
+
+## License
+
+Licensed under the [Apache License, Version 2.0](LICENSE).