chronicle-ds 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.
- chronicle_ds-0.1.0/.gitignore +221 -0
- chronicle_ds-0.1.0/LICENSE +21 -0
- chronicle_ds-0.1.0/PKG-INFO +193 -0
- chronicle_ds-0.1.0/README.md +158 -0
- chronicle_ds-0.1.0/examples/basic.py +0 -0
- chronicle_ds-0.1.0/pyproject.toml +64 -0
- chronicle_ds-0.1.0/src/chronicle/__init__.py +6 -0
- chronicle_ds-0.1.0/src/chronicle/cli.py +70 -0
- chronicle_ds-0.1.0/src/chronicle/core.py +254 -0
- chronicle_ds-0.1.0/src/chronicle/drift.py +305 -0
- chronicle_ds-0.1.0/src/chronicle/exceptions.py +33 -0
- chronicle_ds-0.1.0/src/chronicle/fetch.py +151 -0
- chronicle_ds-0.1.0/src/chronicle/normalize.py +281 -0
- chronicle_ds-0.1.0/src/chronicle/parse.py +127 -0
- chronicle_ds-0.1.0/src/chronicle/profile.py +64 -0
- chronicle_ds-0.1.0/src/chronicle/storage.py +288 -0
- chronicle_ds-0.1.0/tests/__init__.py +0 -0
- chronicle_ds-0.1.0/tests/test_drift.py +84 -0
- chronicle_ds-0.1.0/tests/test_fetch.py +0 -0
- chronicle_ds-0.1.0/tests/test_normalize.py +81 -0
- chronicle_ds-0.1.0/tests/test_parse.py +77 -0
- chronicle_ds-0.1.0/tests/test_profile.py +0 -0
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[codz]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py.cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
# Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# UV
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
# uv.lock
|
|
102
|
+
|
|
103
|
+
# poetry
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
105
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
+
# commonly ignored for libraries.
|
|
107
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
108
|
+
# poetry.lock
|
|
109
|
+
# poetry.toml
|
|
110
|
+
|
|
111
|
+
# pdm
|
|
112
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
113
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
114
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
115
|
+
# pdm.lock
|
|
116
|
+
# pdm.toml
|
|
117
|
+
.pdm-python
|
|
118
|
+
.pdm-build/
|
|
119
|
+
|
|
120
|
+
# pixi
|
|
121
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
122
|
+
# pixi.lock
|
|
123
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
124
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
125
|
+
.pixi
|
|
126
|
+
|
|
127
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
128
|
+
__pypackages__/
|
|
129
|
+
|
|
130
|
+
# Celery stuff
|
|
131
|
+
celerybeat-schedule
|
|
132
|
+
celerybeat.pid
|
|
133
|
+
|
|
134
|
+
# Redis
|
|
135
|
+
*.rdb
|
|
136
|
+
*.aof
|
|
137
|
+
*.pid
|
|
138
|
+
|
|
139
|
+
# RabbitMQ
|
|
140
|
+
mnesia/
|
|
141
|
+
rabbitmq/
|
|
142
|
+
rabbitmq-data/
|
|
143
|
+
|
|
144
|
+
# ActiveMQ
|
|
145
|
+
activemq-data/
|
|
146
|
+
|
|
147
|
+
# SageMath parsed files
|
|
148
|
+
*.sage.py
|
|
149
|
+
|
|
150
|
+
# Environments
|
|
151
|
+
.env
|
|
152
|
+
.envrc
|
|
153
|
+
.venv
|
|
154
|
+
env/
|
|
155
|
+
venv/
|
|
156
|
+
ENV/
|
|
157
|
+
env.bak/
|
|
158
|
+
venv.bak/
|
|
159
|
+
|
|
160
|
+
# Spyder project settings
|
|
161
|
+
.spyderproject
|
|
162
|
+
.spyproject
|
|
163
|
+
|
|
164
|
+
# Rope project settings
|
|
165
|
+
.ropeproject
|
|
166
|
+
|
|
167
|
+
# mkdocs documentation
|
|
168
|
+
/site
|
|
169
|
+
|
|
170
|
+
# mypy
|
|
171
|
+
.mypy_cache/
|
|
172
|
+
.dmypy.json
|
|
173
|
+
dmypy.json
|
|
174
|
+
|
|
175
|
+
# Pyre type checker
|
|
176
|
+
.pyre/
|
|
177
|
+
|
|
178
|
+
# pytype static type analyzer
|
|
179
|
+
.pytype/
|
|
180
|
+
|
|
181
|
+
# Cython debug symbols
|
|
182
|
+
cython_debug/
|
|
183
|
+
|
|
184
|
+
# PyCharm
|
|
185
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
186
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
187
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
188
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
189
|
+
# .idea/
|
|
190
|
+
|
|
191
|
+
# Abstra
|
|
192
|
+
# Abstra is an AI-powered process automation framework.
|
|
193
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
194
|
+
# Learn more at https://abstra.io/docs
|
|
195
|
+
.abstra/
|
|
196
|
+
|
|
197
|
+
# Visual Studio Code
|
|
198
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
199
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
200
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
201
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
202
|
+
# .vscode/
|
|
203
|
+
# Temporary file for partial code execution
|
|
204
|
+
tempCodeRunnerFile.py
|
|
205
|
+
|
|
206
|
+
# Ruff stuff:
|
|
207
|
+
.ruff_cache/
|
|
208
|
+
|
|
209
|
+
# PyPI configuration file
|
|
210
|
+
.pypirc
|
|
211
|
+
|
|
212
|
+
# Marimo
|
|
213
|
+
marimo/_static/
|
|
214
|
+
marimo/_lsp/
|
|
215
|
+
__marimo__/
|
|
216
|
+
|
|
217
|
+
# Streamlit
|
|
218
|
+
.streamlit/secrets.toml
|
|
219
|
+
|
|
220
|
+
# Chronicle run artifacts
|
|
221
|
+
.chronicle/
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Benedict "TheDataNormad" Chidiebere
|
|
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,193 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: chronicle-ds
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: The web scraping library that remembers — DS-native data acquisition with temporal versioning and drift detection.
|
|
5
|
+
Project-URL: Homepage, https://github.com/TheDataNormad/chronicle
|
|
6
|
+
Project-URL: Issues, https://github.com/TheDataNormad/chronicle/issues
|
|
7
|
+
Author-email: Benedict Chidiebere <chidieberebenedict48@gmail.com>
|
|
8
|
+
License: MIT
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Keywords: data quality,data science,drift detection,monitoring,pandas,web scraping
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Intended Audience :: Science/Research
|
|
13
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering
|
|
18
|
+
Requires-Python: >=3.10
|
|
19
|
+
Requires-Dist: httpx>=0.27
|
|
20
|
+
Requires-Dist: pandas>=2.0
|
|
21
|
+
Requires-Dist: pyarrow>=15.0
|
|
22
|
+
Requires-Dist: pydantic>=2.6
|
|
23
|
+
Requires-Dist: pyyaml>=6.0
|
|
24
|
+
Requires-Dist: scipy>=1.11
|
|
25
|
+
Requires-Dist: selectolax>=0.3.21
|
|
26
|
+
Requires-Dist: typer>=0.12
|
|
27
|
+
Provides-Extra: browser
|
|
28
|
+
Requires-Dist: playwright>=1.43; extra == 'browser'
|
|
29
|
+
Provides-Extra: dev
|
|
30
|
+
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
|
|
31
|
+
Requires-Dist: pytest>=8.0; extra == 'dev'
|
|
32
|
+
Requires-Dist: respx>=0.21; extra == 'dev'
|
|
33
|
+
Requires-Dist: ruff>=0.4; extra == 'dev'
|
|
34
|
+
Description-Content-Type: text/markdown
|
|
35
|
+
|
|
36
|
+
# Chronicle
|
|
37
|
+
|
|
38
|
+
> **The web scraping library that remembers.**
|
|
39
|
+
|
|
40
|
+
Chronicle is a data-science-native web scraping framework with **temporal versioning** and **drift detection** built in. Every scrape is stored, profiled, and compared to history — so you know exactly when your data changes and why.
|
|
41
|
+
|
|
42
|
+
[](https://pypi.org/project/chronicle-ds/)
|
|
43
|
+
[](https://www.python.org/downloads/)
|
|
44
|
+
[](https://opensource.org/licenses/MIT)
|
|
45
|
+
[]()
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## Why Chronicle?
|
|
50
|
+
|
|
51
|
+
Existing scraping libraries hand you raw data and walk away. **Chronicle remembers.**
|
|
52
|
+
|
|
53
|
+
| Tool | Strength | The gap Chronicle fills |
|
|
54
|
+
|------|----------|------------------------|
|
|
55
|
+
| Requests | HTTP requests | No parsing, no structure |
|
|
56
|
+
| BeautifulSoup | HTML parsing | No fetching, no data quality |
|
|
57
|
+
| Scrapy | Large-scale crawling | No drift detection, no reproducibility |
|
|
58
|
+
| Selenium | JS-rendered pages | No data pipeline, no versioning |
|
|
59
|
+
| lxml | Fast parsing | No fetching, no schema |
|
|
60
|
+
|
|
61
|
+
Chronicle sits **on top of** these tools and adds the layer data scientists actually need:
|
|
62
|
+
|
|
63
|
+
- 🕐 **Temporal versioning** — every scrape is stored, versioned, and replayable
|
|
64
|
+
- 🔍 **Drift detection** — catch broken selectors before they poison your pipeline
|
|
65
|
+
- 📊 **DataFrame-native** — one line from URL to analysis-ready data
|
|
66
|
+
- 📜 **Reproducible** — every run produces a self-contained artifact
|
|
67
|
+
- ✅ **Schema validation** — data quality enforced at scrape time
|
|
68
|
+
- 🧠 **DS-first design** — built for Jupyter, pandas, and real pipelines
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## Install
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
pip install chronicle-ds
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Chronicle requires **Python 3.10+**.
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Quickstart
|
|
83
|
+
|
|
84
|
+
```python
|
|
85
|
+
from chronicle import Scrape
|
|
86
|
+
|
|
87
|
+
df = Scrape("https://example.com/products").to_dataframe()
|
|
88
|
+
print(df.head())
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## More Control
|
|
92
|
+
|
|
93
|
+
```python
|
|
94
|
+
from chronicle import Scrape
|
|
95
|
+
|
|
96
|
+
df = Scrape(
|
|
97
|
+
url="https://example.com/products",
|
|
98
|
+
selectors={
|
|
99
|
+
"_container": "div.product",
|
|
100
|
+
"name": "h2",
|
|
101
|
+
"price": "span.price",
|
|
102
|
+
"rating": "span.rating",
|
|
103
|
+
},
|
|
104
|
+
pages=5,
|
|
105
|
+
rate_limit=2.0,
|
|
106
|
+
).to_dataframe()
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
## The Core Idea
|
|
112
|
+
|
|
113
|
+
Chronicle treats every scrape as a **versioned event**. This unlocks two things no other scraping library provides:
|
|
114
|
+
|
|
115
|
+
### 1. Temporal Versioning
|
|
116
|
+
|
|
117
|
+
Every run is stored with:
|
|
118
|
+
- Raw HTML
|
|
119
|
+
- Parsed data (Parquet)
|
|
120
|
+
- Statistical profile
|
|
121
|
+
- Run metadata (timestamps, config, library version)
|
|
122
|
+
|
|
123
|
+
```python
|
|
124
|
+
# Query the full history of a scraper
|
|
125
|
+
history = Scrape.history("https://example.com/products")
|
|
126
|
+
history.drift_timeline()
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### 2. Drift Detection
|
|
130
|
+
|
|
131
|
+
Chronicle compares each new run against a baseline and detects:
|
|
132
|
+
- **Schema drift** — columns added, removed, or renamed
|
|
133
|
+
- **Null drift** — fields suddenly returning `None`
|
|
134
|
+
- **Distribution drift** — mean, median, or variance shifts
|
|
135
|
+
- **Range drift** — values outside historical bounds
|
|
136
|
+
- **Selector health** — selectors returning zero elements
|
|
137
|
+
|
|
138
|
+
```python
|
|
139
|
+
result = Scrape("https://example.com/products").run()
|
|
140
|
+
|
|
141
|
+
if result.drift_detected:
|
|
142
|
+
print(result.drift_report())
|
|
143
|
+
# ⚠️ price null% jumped from 0.02 → 0.98 (selector likely broken)
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Status
|
|
149
|
+
|
|
150
|
+
🚧 **Early development.** v0.1.0 in progress.
|
|
151
|
+
|
|
152
|
+
### What's built
|
|
153
|
+
- [x] HTTP layer (`fetch.py`) — retries, rate limiting, caching
|
|
154
|
+
- [ ] HTML parsing (`parse.py`)
|
|
155
|
+
- [ ] Schema validation (`normalize.py`)
|
|
156
|
+
- [ ] `Scrape` class (`core.py`)
|
|
157
|
+
- [ ] Storage + versioning (`storage.py`)
|
|
158
|
+
- [ ] Profile generator (`profile.py`)
|
|
159
|
+
- [ ] Drift detection (`drift.py`)
|
|
160
|
+
|
|
161
|
+
### Roadmap
|
|
162
|
+
- Data contracts (schema + quality guarantees)
|
|
163
|
+
- Reproducibility artifacts
|
|
164
|
+
- Self-healing selectors
|
|
165
|
+
- Playwright support for JS-rendered pages
|
|
166
|
+
- CLI + recipe system
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
## Contributing
|
|
171
|
+
|
|
172
|
+
Chronicle is in early, fast-moving development. Issues, ideas, and PRs are welcome.
|
|
173
|
+
|
|
174
|
+
```bash
|
|
175
|
+
git clone git@github.com:TheDataNormad/chronicle.git
|
|
176
|
+
cd chronicle
|
|
177
|
+
python -m venv .venv
|
|
178
|
+
source .venv/Scripts/activate # Windows
|
|
179
|
+
pip install -e ".[dev]"
|
|
180
|
+
pytest
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## License
|
|
186
|
+
|
|
187
|
+
MIT — see [LICENSE](LICENSE).
|
|
188
|
+
|
|
189
|
+
---
|
|
190
|
+
|
|
191
|
+
## Author
|
|
192
|
+
|
|
193
|
+
Built by [@TheDataNormad](https://github.com/TheDataNormad).
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# Chronicle
|
|
2
|
+
|
|
3
|
+
> **The web scraping library that remembers.**
|
|
4
|
+
|
|
5
|
+
Chronicle is a data-science-native web scraping framework with **temporal versioning** and **drift detection** built in. Every scrape is stored, profiled, and compared to history — so you know exactly when your data changes and why.
|
|
6
|
+
|
|
7
|
+
[](https://pypi.org/project/chronicle-ds/)
|
|
8
|
+
[](https://www.python.org/downloads/)
|
|
9
|
+
[](https://opensource.org/licenses/MIT)
|
|
10
|
+
[]()
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Why Chronicle?
|
|
15
|
+
|
|
16
|
+
Existing scraping libraries hand you raw data and walk away. **Chronicle remembers.**
|
|
17
|
+
|
|
18
|
+
| Tool | Strength | The gap Chronicle fills |
|
|
19
|
+
|------|----------|------------------------|
|
|
20
|
+
| Requests | HTTP requests | No parsing, no structure |
|
|
21
|
+
| BeautifulSoup | HTML parsing | No fetching, no data quality |
|
|
22
|
+
| Scrapy | Large-scale crawling | No drift detection, no reproducibility |
|
|
23
|
+
| Selenium | JS-rendered pages | No data pipeline, no versioning |
|
|
24
|
+
| lxml | Fast parsing | No fetching, no schema |
|
|
25
|
+
|
|
26
|
+
Chronicle sits **on top of** these tools and adds the layer data scientists actually need:
|
|
27
|
+
|
|
28
|
+
- 🕐 **Temporal versioning** — every scrape is stored, versioned, and replayable
|
|
29
|
+
- 🔍 **Drift detection** — catch broken selectors before they poison your pipeline
|
|
30
|
+
- 📊 **DataFrame-native** — one line from URL to analysis-ready data
|
|
31
|
+
- 📜 **Reproducible** — every run produces a self-contained artifact
|
|
32
|
+
- ✅ **Schema validation** — data quality enforced at scrape time
|
|
33
|
+
- 🧠 **DS-first design** — built for Jupyter, pandas, and real pipelines
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Install
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
pip install chronicle-ds
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Chronicle requires **Python 3.10+**.
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Quickstart
|
|
48
|
+
|
|
49
|
+
```python
|
|
50
|
+
from chronicle import Scrape
|
|
51
|
+
|
|
52
|
+
df = Scrape("https://example.com/products").to_dataframe()
|
|
53
|
+
print(df.head())
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## More Control
|
|
57
|
+
|
|
58
|
+
```python
|
|
59
|
+
from chronicle import Scrape
|
|
60
|
+
|
|
61
|
+
df = Scrape(
|
|
62
|
+
url="https://example.com/products",
|
|
63
|
+
selectors={
|
|
64
|
+
"_container": "div.product",
|
|
65
|
+
"name": "h2",
|
|
66
|
+
"price": "span.price",
|
|
67
|
+
"rating": "span.rating",
|
|
68
|
+
},
|
|
69
|
+
pages=5,
|
|
70
|
+
rate_limit=2.0,
|
|
71
|
+
).to_dataframe()
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## The Core Idea
|
|
77
|
+
|
|
78
|
+
Chronicle treats every scrape as a **versioned event**. This unlocks two things no other scraping library provides:
|
|
79
|
+
|
|
80
|
+
### 1. Temporal Versioning
|
|
81
|
+
|
|
82
|
+
Every run is stored with:
|
|
83
|
+
- Raw HTML
|
|
84
|
+
- Parsed data (Parquet)
|
|
85
|
+
- Statistical profile
|
|
86
|
+
- Run metadata (timestamps, config, library version)
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
# Query the full history of a scraper
|
|
90
|
+
history = Scrape.history("https://example.com/products")
|
|
91
|
+
history.drift_timeline()
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 2. Drift Detection
|
|
95
|
+
|
|
96
|
+
Chronicle compares each new run against a baseline and detects:
|
|
97
|
+
- **Schema drift** — columns added, removed, or renamed
|
|
98
|
+
- **Null drift** — fields suddenly returning `None`
|
|
99
|
+
- **Distribution drift** — mean, median, or variance shifts
|
|
100
|
+
- **Range drift** — values outside historical bounds
|
|
101
|
+
- **Selector health** — selectors returning zero elements
|
|
102
|
+
|
|
103
|
+
```python
|
|
104
|
+
result = Scrape("https://example.com/products").run()
|
|
105
|
+
|
|
106
|
+
if result.drift_detected:
|
|
107
|
+
print(result.drift_report())
|
|
108
|
+
# ⚠️ price null% jumped from 0.02 → 0.98 (selector likely broken)
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## Status
|
|
114
|
+
|
|
115
|
+
🚧 **Early development.** v0.1.0 in progress.
|
|
116
|
+
|
|
117
|
+
### What's built
|
|
118
|
+
- [x] HTTP layer (`fetch.py`) — retries, rate limiting, caching
|
|
119
|
+
- [ ] HTML parsing (`parse.py`)
|
|
120
|
+
- [ ] Schema validation (`normalize.py`)
|
|
121
|
+
- [ ] `Scrape` class (`core.py`)
|
|
122
|
+
- [ ] Storage + versioning (`storage.py`)
|
|
123
|
+
- [ ] Profile generator (`profile.py`)
|
|
124
|
+
- [ ] Drift detection (`drift.py`)
|
|
125
|
+
|
|
126
|
+
### Roadmap
|
|
127
|
+
- Data contracts (schema + quality guarantees)
|
|
128
|
+
- Reproducibility artifacts
|
|
129
|
+
- Self-healing selectors
|
|
130
|
+
- Playwright support for JS-rendered pages
|
|
131
|
+
- CLI + recipe system
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## Contributing
|
|
136
|
+
|
|
137
|
+
Chronicle is in early, fast-moving development. Issues, ideas, and PRs are welcome.
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
git clone git@github.com:TheDataNormad/chronicle.git
|
|
141
|
+
cd chronicle
|
|
142
|
+
python -m venv .venv
|
|
143
|
+
source .venv/Scripts/activate # Windows
|
|
144
|
+
pip install -e ".[dev]"
|
|
145
|
+
pytest
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## License
|
|
151
|
+
|
|
152
|
+
MIT — see [LICENSE](LICENSE).
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## Author
|
|
157
|
+
|
|
158
|
+
Built by [@TheDataNormad](https://github.com/TheDataNormad).
|
|
File without changes
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "chronicle-ds"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "The web scraping library that remembers — DS-native data acquisition with temporal versioning and drift detection."
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
license = { text = "MIT" }
|
|
7
|
+
requires-python = ">=3.10"
|
|
8
|
+
authors = [
|
|
9
|
+
{ name = "Benedict Chidiebere", email = "chidieberebenedict48@gmail.com" }
|
|
10
|
+
]
|
|
11
|
+
keywords = ["web scraping", "data science", "drift detection", "data quality", "pandas", "monitoring"]
|
|
12
|
+
classifiers = [
|
|
13
|
+
"Development Status :: 3 - Alpha",
|
|
14
|
+
"Intended Audience :: Science/Research",
|
|
15
|
+
"License :: OSI Approved :: MIT License",
|
|
16
|
+
"Programming Language :: Python :: 3.10",
|
|
17
|
+
"Programming Language :: Python :: 3.11",
|
|
18
|
+
"Programming Language :: Python :: 3.12",
|
|
19
|
+
"Topic :: Scientific/Engineering",
|
|
20
|
+
]
|
|
21
|
+
|
|
22
|
+
dependencies = [
|
|
23
|
+
"httpx>=0.27",
|
|
24
|
+
"selectolax>=0.3.21",
|
|
25
|
+
"pydantic>=2.6",
|
|
26
|
+
"pandas>=2.0",
|
|
27
|
+
"pyarrow>=15.0",
|
|
28
|
+
"pyyaml>=6.0",
|
|
29
|
+
"scipy>=1.11", # for KS test / drift detection
|
|
30
|
+
"typer>=0.12", # CLI
|
|
31
|
+
]
|
|
32
|
+
|
|
33
|
+
[project.optional-dependencies]
|
|
34
|
+
dev = [
|
|
35
|
+
"pytest>=8.0",
|
|
36
|
+
"pytest-cov>=5.0",
|
|
37
|
+
"respx>=0.21",
|
|
38
|
+
"ruff>=0.4",
|
|
39
|
+
]
|
|
40
|
+
browser = [
|
|
41
|
+
"playwright>=1.43", # optional JS rendering
|
|
42
|
+
]
|
|
43
|
+
|
|
44
|
+
[project.scripts]
|
|
45
|
+
chronicle = "chronicle.cli:app"
|
|
46
|
+
|
|
47
|
+
[project.urls]
|
|
48
|
+
Homepage = "https://github.com/TheDataNormad/chronicle"
|
|
49
|
+
Issues = "https://github.com/TheDataNormad/chronicle/issues"
|
|
50
|
+
|
|
51
|
+
[build-system]
|
|
52
|
+
requires = ["hatchling"]
|
|
53
|
+
build-backend = "hatchling.build"
|
|
54
|
+
|
|
55
|
+
[tool.hatch.build.targets.wheel]
|
|
56
|
+
packages = ["src/chronicle"]
|
|
57
|
+
|
|
58
|
+
[tool.ruff]
|
|
59
|
+
line-length = 100
|
|
60
|
+
target-version = "py310"
|
|
61
|
+
|
|
62
|
+
[tool.pytest.ini_options]
|
|
63
|
+
testpaths = ["tests"]
|
|
64
|
+
addopts = "-v --cov=chronicle --cov-report=term-missing"
|