scitex-template 0.1.0__tar.gz

scitex_template-0.1.0/.github/workflows/cla.yml

@@ -0,0 +1,28 @@
+name: CLA Assistant
+
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened, closed, synchronize]
+
+permissions:
+  actions: write
+  contents: write
+  pull-requests: write
+  statuses: write
+
+jobs:
+  CLAssistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: CLA Assistant
+        uses: contributor-assistant/github-action@v2.6.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+        with:
+          path-to-signatures: "signatures/cla.json"
+          path-to-document: "https://github.com/ywatanabe1989/scitex-scholar/blob/main/CLA.md"
+          branch: "cla-signatures"
+          allowlist: bot*,ywatanabe1989

scitex_template-0.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,27 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/scitex-template
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install build tools
+        run: pip install build
+      - name: Build distribution
+        run: python -m build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

scitex_template-0.1.0/.github/workflows/scitex-quality.yml

@@ -0,0 +1,68 @@
+# SciTeX ecosystem quality audit.
+#
+# Runs weekly (Mondays 06:00 UTC) and on every push to main/develop.
+# Warn-only by default: the job surfaces violations in the Actions summary
+# but does not fail the build. Flip `continue-on-error: false` on individual
+# steps once your package is clean and you want the gate enforced.
+#
+# Rules checked:
+#   - audit-cli          noun-verb convention for Click subcommands
+#   - audit-frontmatter  YAML frontmatter on every _skills/*.md (FM-0..FM-6)
+#   - audit-docs         drift between SKILL.md examples and real code
+#   - audit-lines        per-file line-count allowlist
+#   - audit-scope        public API covered by tests
+name: SciTeX Quality
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+  schedule:
+    - cron: "0 6 * * 1"  # Mondays 06:00 UTC
+  workflow_dispatch:
+
+jobs:
+  audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install package + scitex-dev audit extras
+        run: |
+          pip install -e . || true
+          pip install "scitex-dev[cli-audit] @ git+https://github.com/scitex-project/scitex-dev.git@main"
+
+      - name: Detect package name
+        id: pkg
+        run: |
+          pkg=$(python -c "import tomllib,sys; d=tomllib.load(open('pyproject.toml','rb')); print(d['project']['name'])")
+          echo "name=$pkg" >> "$GITHUB_OUTPUT"
+          echo "import_name=$(echo $pkg | tr - _)" >> "$GITHUB_OUTPUT"
+
+      - name: audit-cli
+        continue-on-error: true
+        run: scitex-dev quality audit-cli ${{ steps.pkg.outputs.name }} | tee -a "$GITHUB_STEP_SUMMARY"
+
+      - name: audit-frontmatter
+        continue-on-error: true
+        run: |
+          skills_dir="src/${{ steps.pkg.outputs.import_name }}/_skills"
+          [ -d "$skills_dir" ] && scitex-dev quality audit-frontmatter "$skills_dir" | tee -a "$GITHUB_STEP_SUMMARY" || echo "no _skills dir, skipping" >> "$GITHUB_STEP_SUMMARY"
+
+      - name: audit-docs
+        continue-on-error: true
+        run: scitex-dev quality audit-docs ${{ steps.pkg.outputs.name }} | tee -a "$GITHUB_STEP_SUMMARY"
+
+      - name: audit-lines
+        continue-on-error: true
+        run: scitex-dev quality audit-lines | tee -a "$GITHUB_STEP_SUMMARY"
+
+      - name: audit-scope
+        continue-on-error: true
+        run: scitex-dev quality audit-scope ${{ steps.pkg.outputs.name }} | tee -a "$GITHUB_STEP_SUMMARY"

scitex_template-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+  schedule:
+    - cron: "0 7 * * *"  # nightly 07:00 UTC
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      - name: Run tests
+        run: python -m pytest tests/ -v --tb=short

scitex_template-0.1.0/.gitignore

@@ -0,0 +1,20 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.testmondata*
+.coverage*
+htmlcov/
+.venv/
+.env
+.env.*
+!.env.example
+.scitex/
+.claude/
+.playwright-cli/
+logs/
+*.log
+.DS_Store

scitex_template-0.1.0/CLA.md

@@ -0,0 +1,80 @@
+# SciTeX Contributor License Agreement (CLA)
+
+Version 1.0 — Effective 2026-03-12
+
+## Purpose
+
+SciTeX is licensed under AGPL-3.0 and follows a dual-licensing model:
+
+- **Researchers and individuals**: Free forever under AGPL-3.0.
+- **Enterprises and institutions**: Commercial license available upon request.
+
+To maintain the ability to offer dual licensing and ensure the long-term
+sustainability of the project, we ask contributors to sign this CLA before
+their first contribution is merged.
+
+## Agreement
+
+By submitting a pull request or other contribution to any SciTeX repository,
+you agree to the following terms:
+
+### 1. You retain copyright
+
+You retain full copyright ownership of your contributions.
+
+### 2. You grant a broad license to the project
+
+You grant Yusuke Watanabe, and any successor entity operating the SciTeX
+project (the "Project Lead"), a perpetual, worldwide, non-exclusive,
+royalty-free, irrevocable license to:
+
+- Use, reproduce, modify, and distribute your contributions.
+- Sublicense your contributions under alternative licenses, including
+  dual-licensing for institutional and commercial use, for the purpose of
+  sustaining the SciTeX project.
+
+### 3. You confirm originality
+
+You confirm that:
+
+- Your contributions are your original work.
+- You have the legal right to grant the above license.
+- Your contributions do not infringe on third-party rights.
+
+If any portion is based on existing work, you have disclosed the source and
+confirmed its license is compatible with AGPL-3.0.
+
+### 4. No obligation
+
+This agreement does not create any obligation for the Project Lead to use,
+merge, or maintain your contributions.
+
+## How to sign
+
+When you open your first pull request, the CLA Assistant bot will ask you to
+sign electronically. This is a one-time process per contributor.
+
+Alternatively, you may sign by adding the following statement to your pull
+request description:
+
+> I have read and agree to the [SciTeX CLA](CLA.md).
+
+## Why a CLA?
+
+SciTeX aims to be free for researchers forever. A CLA ensures the project can:
+
+- Offer institutional/campus licenses to universities and companies.
+- Change licenses if needed to protect the community (e.g., against
+  proprietary forks).
+- Provide legal clarity for institutions adopting SciTeX.
+
+Revenue from commercial licensing accrues to the Project Lead and is used to
+sustain the SciTeX project.
+
+This is the same approach used by MongoDB, Elasticsearch, and many other
+successful open-source projects with dual-licensing models.
+
+## Questions
+
+If you have questions about this CLA, please open an issue or contact
+ywatanabe@scitex.ai.

scitex_template-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# Contributing to SciTeX
+
+Thank you for your interest in contributing to SciTeX. This guide covers the
+process for reporting issues, suggesting features, and submitting code.
+
+## Contributor License Agreement
+
+Before your first contribution can be merged, you must agree to the
+[SciTeX CLA](CLA.md). This is a one-time process. The CLA ensures that:
+
+- You retain copyright of your work.
+- The project can continue to offer dual licensing (free for researchers,
+  commercial for enterprises).
+
+See [CLA.md](CLA.md) for full details.
+
+## Reporting Issues
+
+- Search [existing issues](https://github.com/ywatanabe1989/scitex-scholar/issues)
+  before opening a new one.
+- Include a minimal reproducible example when reporting bugs.
+- Specify your Python version, OS, and `scitex` version.
+
+## Development Setup
+
+```bash
+git clone git@github.com:ywatanabe1989/scitex-scholar.git
+cd scitex-scholar
+pip install -e ".[dev]"
+```
+
+## Branch Workflow
+
+- `main` — stable releases only. Do not push directly.
+- `develop` — integration branch. PRs target here.
+- Feature branches — create from `develop`, name as `feature/<description>`.
+
+```bash
+git checkout develop
+git checkout -b feature/my-change
+# ... make changes ...
+git push origin feature/my-change
+# Open PR targeting develop
+```
+
+## Code Style
+
+- Follow existing conventions in the codebase.
+- Use `_` prefix for internal/private modules and functions.
+- Keep files under 512 lines.
+- Run tests before submitting:
+
+```bash
+pytest tests/ -x -q
+```
+
+## Pull Request Process
+
+1. Ensure your branch is up to date with `develop`.
+2. Write tests for new functionality.
+3. Run the test suite and confirm all tests pass.
+4. Open a PR targeting `develop` with a clear description.
+5. The CLA bot will check your CLA status on your first PR.
+
+## License
+
+By contributing, you agree to the terms of the [CLA](CLA.md), which includes
+licensing under AGPL-3.0 (see [LICENSE](LICENSE)) and the dual-licensing
+provisions described therein.