Packaging and Sharing¶
QLens supports two different distribution forms.
Full repository ZIP¶
A full repository ZIP contains source code, canonical records, schemas, contracts, tests, documentation, NUR assets, and Git-friendly project files.
Linux/macOS:
mkdir -p dist
zip -r dist/qlens-complete.zip . \
-x '.git/*' '.venv/*' 'site/*' '__pycache__/*' '*.pyc' 'dist/*'
PowerShell:
New-Item -ItemType Directory -Force dist | Out-Null
Compress-Archive -Path CHANGELOG.md,README.md,pyproject.toml,mkdocs.yml,contracts,docs,examples,overrides,repository,schemas,scripts,src,templates,tests -DestinationPath dist\qlens-complete.zip -Force
QLens knowledge package¶
A knowledge package is a selected, portable research export:
qlens pack dist/research-space.zip --space RSP-000001
Include history:
qlens pack dist/research-space-with-history.zip \
--space RSP-000001 \
--include-history
Include more than one Research Space:
qlens pack dist/combined.zip \
--space RSP-000001 \
--space RSP-000002
Verify a generated ZIP¶
Linux/macOS:
unzip -t dist/research-space.zip
sha256sum dist/research-space.zip
PowerShell:
Get-FileHash dist\research-space.zip -Algorithm SHA256
Before sharing¶
pytest
python scripts/validate_repo.py
qlens build
qlens doctor
mkdocs build --strict