e3cli 0.3.1__tar.gz

e3cli-0.3.1/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          pip install -e ".[dev]"
+
+      - name: Lint
+        run: ruff check e3cli/
+
+      - name: Test
+        run: pytest --tb=short -q
+
+      - name: Verify CLI loads
+        run: e3cli version

e3cli-0.3.1/.github/workflows/release.yml

@@ -0,0 +1,117 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: pip install twine && twine upload dist/*
+
+  update-homebrew:
+    needs: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Calculate tarball sha256
+        id: sha
+        run: |
+          TARBALL_URL="https://github.com/${{ github.repository }}/archive/refs/tags/${{ github.ref_name }}.tar.gz"
+          echo "url=${TARBALL_URL}" >> "$GITHUB_OUTPUT"
+          SHA=$(curl -sL "${TARBALL_URL}" | sha256sum | cut -d' ' -f1)
+          echo "sha256=${SHA}" >> "$GITHUB_OUTPUT"
+          echo "Tarball: ${TARBALL_URL}"
+          echo "SHA256:  ${SHA}"
+
+      - name: Clone homebrew tap
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.repository_owner }}/homebrew-e3cli
+          token: ${{ secrets.TAP_GITHUB_TOKEN }}
+          path: homebrew-tap
+
+      - name: Update formula
+        run: |
+          cat > homebrew-tap/Formula/e3cli.rb << 'FORMULA_EOF'
+          class E3cli < Formula
+            include Language::Python::Virtualenv
+
+            desc "NYCU E3 Moodle automation CLI — sync courses, download materials, submit assignments"
+            homepage "https://github.com/${{ github.repository }}"
+            url "${{ steps.sha.outputs.url }}"
+            sha256 "${{ steps.sha.outputs.sha256 }}"
+            license "MIT"
+
+            depends_on "python@3.12"
+          FORMULA_EOF
+
+          # Append dependency resources from PyPI
+          python3 -c "
+          import json, urllib.request
+          deps = ['typer', 'requests', 'rich']
+          for pkg in deps:
+              info = json.loads(urllib.request.urlopen(f'https://pypi.org/pypi/{pkg}/json').read())
+              ver = info['info']['version']
+              for f in info['releases'][ver]:
+                  if f['packagetype'] == 'sdist':
+                      print(f'')
+                      print(f'  resource \"{pkg}\" do')
+                      print(f'    url \"{f[\"url\"]}\"')
+                      print(f'    sha256 \"{f[\"digests\"][\"sha256\"]}\"')
+                      print(f'  end')
+                      break
+          " >> homebrew-tap/Formula/e3cli.rb
+
+          # Append install and test blocks
+          cat >> homebrew-tap/Formula/e3cli.rb << 'TAIL_EOF'
+
+            def install
+              virtualenv_install_with_resources
+            end
+
+            test do
+              assert_match "e3cli", shell_output("#{bin}/e3cli version")
+            end
+          end
+          TAIL_EOF
+
+          echo "=== Generated formula ==="
+          cat homebrew-tap/Formula/e3cli.rb
+
+      - name: Push updated formula
+        run: |
+          cd homebrew-tap
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add Formula/e3cli.rb
+          git diff --cached --quiet && echo "No changes" && exit 0
+          git commit -m "Update e3cli to ${{ github.ref_name }}"
+          git push

e3cli-0.3.1/.gitignore

@@ -0,0 +1,19 @@
+__pycache__/
+*.pyc
+*.egg-info/
+dist/
+build/
+.venv/
+*.db
+.claude/
+.DS_Store
+scripts/
+
+# Credentials — never commit
+.e3cli/
+token
+*.enc
+key
+credentials.enc
+homebrew-e3cli/
+

e3cli-0.3.1/Formula/e3cli.rb

@@ -0,0 +1,35 @@
+class E3cli < Formula
+  include Language::Python::Virtualenv
+
+  desc "NYCU E3 Moodle automation CLI — sync courses, download materials, submit assignments"
+  homepage "https://github.com/junlinwk/e3cli"
+  url "https://github.com/junlinwk/e3cli/archive/refs/tags/v0.1.0.tar.gz"
+  sha256 "7aa0147a0301b7fcd69502689cece3d648dc19f2ce6025b131b325b31300367a"
+  license "MIT"
+
+  depends_on "python@3.12"
+
+  resource "typer" do
+    url "https://files.pythonhosted.org/packages/f5/24/cb09efec5cc954f7f9b930bf8279447d24618bb6758d4f6adf2574c41780/typer-0.24.1.tar.gz"
+    sha256 "e39b4732d65fbdcde189ae76cf7cd48aeae72919dea1fdfc16593be016256b45"
+  end
+
+  resource "requests" do
+    url "https://files.pythonhosted.org/packages/34/64/8860370b167a9721e8956ae116825caff829224fbca0ca6e7bf8ddef8430/requests-2.33.0.tar.gz"
+    sha256 "c7ebc5e8b0f21837386ad0e1c8fe8b829fa5f544d8df3b2253bff14ef29d7652"
+  end
+
+  resource "rich" do
+    url "https://files.pythonhosted.org/packages/b3/c6/f3b320c27991c46f43ee9d856302c70dc2d0fb2dba4842ff739d5f46b393/rich-14.3.3.tar.gz"
+    sha256 "b8daa0b9e4eef54dd8cf7c86c03713f53241884e814f4e2f5fb342fe520f639b"
+  end
+
+  def install
+    virtualenv_install_with_resources
+  end
+
+  test do
+    assert_match "e3cli", shell_output("#{bin}/e3cli version")
+  end
+end
+ ㄍ

e3cli-0.3.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 E3CLI Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

e3cli-0.3.1/Makefile

@@ -0,0 +1,26 @@
+.PHONY: install dev lint test build clean
+
+install:  ## Install e3cli
+	pip install .
+
+dev:  ## Install in development mode with dev dependencies
+	pip install -e ".[dev]"
+
+lint:  ## Run linter
+	ruff check e3cli/
+
+test:  ## Run tests
+	pytest --tb=short -q
+
+build:  ## Build distribution packages
+	python -m build
+
+clean:  ## Remove build artifacts
+	rm -rf dist/ build/ *.egg-info/
+	find . -type d -name __pycache__ -exec rm -rf {} +
+
+formula:  ## Generate Homebrew formula (requires version tag, e.g. make formula TAG=v0.1.0)
+	python scripts/generate-formula.py $(TAG)
+
+help:  ## Show this help
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-12s\033[0m %s\n", $$1, $$2}'

e3cli-0.3.1/PKG-INFO

@@ -0,0 +1,370 @@
+Metadata-Version: 2.4
+Name: e3cli
+Version: 0.3.1
+Summary: NYCU E3 Moodle automation CLI — sync courses, download materials, submit assignments.
+Project-URL: Homepage, https://github.com/junlinwk/e3cli
+Project-URL: Repository, https://github.com/junlinwk/e3cli
+Project-URL: Issues, https://github.com/junlinwk/e3cli/issues
+Author: E3CLI Contributors
+License-Expression: MIT
+License-File: LICENSE
+Keywords: automation,cli,e3,moodle,nycu
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Education
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Education
+Requires-Python: >=3.11
+Requires-Dist: requests>=2.31
+Requires-Dist: rich>=13.0
+Requires-Dist: typer>=0.9
+Provides-Extra: ai
+Requires-Dist: anthropic>=0.18; extra == 'ai'
+Requires-Dist: pymupdf>=1.23; extra == 'ai'
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# e3cli
+
+NYCU E3 Moodle automation CLI -- sync courses, download materials, submit assignments from your terminal.
+
+## Features
+
+- **Login** -- authenticate via Moodle Web Service API, encrypted credential storage
+- **Courses** -- list all enrolled courses
+- **Assignments** -- view assignments, deadlines, submission status
+- **Download** -- batch download course materials, skip already-downloaded files
+- **Submit** -- upload and submit assignments from CLI
+- **Sync** -- one command to pull everything new (materials + assignment status)
+- **Schedule** -- cron-based automatic sync
+
+## Supported Platforms
+
+| Platform | Architecture | Status |
+|----------|-------------|--------|
+| macOS | Apple Silicon (ARM64) | Supported |
+| macOS | Intel (x86_64) | Supported |
+| Linux | x86_64 | Supported |
+| Linux | ARM64 | Supported |
+
+Requires **Python 3.11+**.
+
+---
+
+## Installation
+
+### Option 1: Homebrew (recommended for macOS/Linux)
+
+```bash
+# Add the tap
+brew tap junlinwk/e3cli
+
+# Install
+brew install e3cli
+
+# Verify
+e3cli version
+```
+
+### Option 2: pipx (isolated install, recommended for Linux)
+
+```bash
+# Install pipx if you don't have it
+brew install pipx   # or: apt install pipx
+pipx ensurepath
+
+# Install e3cli
+pipx install e3cli
+
+# Verify
+e3cli version
+```
+
+### Option 3: pip
+
+```bash
+pip install e3cli
+```
+
+### Option 4: From source (development)
+
+```bash
+git clone https://github.com/junlinwk/e3cli.git
+cd e3cli
+pip install -e ".[dev]"
+```
+
+## Update
+---
+
+## Quick Start
+
+```bash
+# 1. Login (first time)
+e3cli login --save        # --save encrypts and stores your credentials locally
+
+# 2. List your courses
+e3cli courses
+
+# 3. Download all course materials
+e3cli download --all
+
+# 4. Check assignments and deadlines
+e3cli assignments
+
+# 5. Submit an assignment
+e3cli submit <assignment-id> homework.pdf
+
+# 6. Enable automatic sync (every hour)
+e3cli schedule enable
+```
+
+---
+
+## Commands
+
+### `e3cli login`
+
+Authenticate with your Moodle account and store the API token.
+
+```bash
+e3cli login                    # Interactive prompt
+e3cli login -u <student-id>    # Specify username
+e3cli login --save             # Save credentials (encrypted) for auto-refresh
+e3cli login --refresh          # Re-authenticate using saved credentials
+```
+
+### `e3cli logout`
+
+Securely erase all stored credentials and tokens.
+
+```bash
+e3cli logout
+```
+
+### `e3cli courses`
+
+List all enrolled courses in a formatted table.
+
+```bash
+e3cli courses
+```
+
+### `e3cli assignments`
+
+View assignments with deadlines and submission status.
+
+```bash
+e3cli assignments                  # All assignments
+e3cli assignments --due-soon 7     # Due within 7 days
+```
+
+### `e3cli download`
+
+Download course materials to local disk.
+
+```bash
+e3cli download --all               # All courses
+e3cli download --course "OS"       # Filter by course name/code
+```
+
+Files are saved to `~/e3-downloads/<course>/<section>/` by default. Already-downloaded files are skipped automatically (tracked via SQLite).
+
+### `e3cli submit`
+
+Upload and submit an assignment.
+
+```bash
+e3cli submit <assignment-id> file1.pdf file2.zip
+e3cli submit <assignment-id> report.pdf --text "Some notes"
+e3cli submit <assignment-id> late-hw.pdf --force     # Submit past deadline
+```
+
+### `e3cli sync`
+
+Pull all new materials and update assignment status in one command.
+
+```bash
+e3cli sync                # Interactive output
+e3cli sync --quiet        # Silent mode (for cron)
+```
+
+### `e3cli schedule`
+
+Manage automatic sync via system crontab.
+
+```bash
+e3cli schedule enable                  # Default: every 60 minutes
+e3cli schedule enable --interval 30    # Every 30 minutes
+e3cli schedule disable                 # Remove cron job
+e3cli schedule status                  # Show current schedule
+```
+
+### `e3cli version`
+
+```bash
+e3cli version
+```
+
+---
+
+## Configuration
+
+Config file: `~/.e3cli/config.toml`
+
+```toml
+[moodle]
+url = "https://e3p.nycu.edu.tw"    # Your Moodle instance URL
+service = "moodle_mobile_app"       # Web service name (usually don't change)
+
+[storage]
+download_dir = "~/e3-downloads"     # Where to save course materials
+db_path = "~/.e3cli/data/e3cli.db"  # Tracking database
+
+[schedule]
+interval_minutes = 60               # Sync interval for cron job
+notify = true                       # Desktop notifications (future)
+```
+
+The config file is auto-created with defaults on first run. Edit it to customize behavior.
+
+---
+
+## Security
+
+### Credential Storage
+
+e3cli uses **Fernet symmetric encryption** (from the `cryptography` library) to protect stored credentials:
+
+```
+~/.e3cli/
+  key               # Random 256-bit encryption key (chmod 600)
+  credentials.enc   # Encrypted username + password (chmod 600)
+  token             # Moodle API token (chmod 600)
+```
+
+- Encryption key is randomly generated per machine and stored separately from credentials
+- All sensitive files are created with `chmod 600` (owner-only read/write)
+- Passwords are **never** stored in plaintext or passed as CLI arguments (uses `getpass`)
+- `e3cli logout` securely overwrites files with zeros before deletion
+
+### What's NOT stored
+
+- Your password is never written to shell history (interactive `getpass` prompt)
+- No credentials in `config.toml`
+- No credentials in environment variables
+
+### Recommendations
+
+- Use `e3cli login --save` only on machines you trust
+- Run `e3cli logout` when done on shared machines
+- The `~/.e3cli/` directory is in `.gitignore` -- never commit it
+
+---
+
+## Local Data
+
+| Path | Purpose |
+|------|---------|
+| `~/.e3cli/config.toml` | User configuration |
+| `~/.e3cli/token` | Moodle API token (encrypted-equivalent, chmod 600) |
+| `~/.e3cli/key` | Encryption key (chmod 600) |
+| `~/.e3cli/credentials.enc` | Encrypted credentials (chmod 600) |
+| `~/.e3cli/data/e3cli.db` | SQLite tracking DB (downloaded files, assignment status) |
+| `~/e3-downloads/` | Downloaded course materials |
+
+
+---
+
+## Project Structure
+
+```
+e3cli/
+├── pyproject.toml              # Package metadata and dependencies
+├── Makefile                    # Dev shortcuts (make dev, make test, etc.)
+├── LICENSE                     # MIT License
+├── Formula/e3cli.rb            # Homebrew formula template
+├── scripts/
+│   ├── generate-formula.py     # Auto-generate formula from PyPI
+│   └── setup-homebrew-tap.sh   # Bootstrap Homebrew tap repo
+├── .github/workflows/
+│   ├── ci.yml                  # Test on push/PR (Linux + macOS, Py 3.11-3.13)
+│   └── release.yml             # Build + publish on tag push
+├── e3cli/
+│   ├── __init__.py
+│   ├── __main__.py             # python -m e3cli
+│   ├── cli.py                  # Typer CLI entry point
+│   ├── config.py               # ~/.e3cli/config.toml management
+│   ├── auth.py                 # Moodle token authentication
+│   ├── credential.py           # Encrypted credential storage
+│   ├── api/
+│   │   ├── client.py           # Moodle REST API client
+│   │   ├── site.py             # Site info
+│   │   ├── courses.py          # Course listing and contents
+│   │   ├── assignments.py      # Assignment queries and submission
+│   │   └── files.py            # File download
+│   ├── storage/
+│   │   ├── db.py               # SQLite schema and operations
+│   │   ├── models.py           # Data models
+│   │   └── tracking.py         # Download/assignment tracking
+│   ├── commands/
+│   │   ├── _common.py          # Shared utilities (get_client, get_db)
+│   │   ├── login.py            # e3cli login
+│   │   ├── logout.py           # e3cli logout
+│   │   ├── courses.py          # e3cli courses
+│   │   ├── assignments.py      # e3cli assignments
+│   │   ├── download.py         # e3cli download
+│   │   ├── submit.py           # e3cli submit
+│   │   ├── sync.py             # e3cli sync
+│   │   └── schedule.py         # e3cli schedule
+│   ├── scheduler/
+│   │   └── cron.py             # Crontab management
+│   └── ai/                     # Future: AI integration
+│       └── __init__.py
+└── tests/
+```
+
+---
+
+## Development
+
+```bash
+# Clone and install in dev mode
+git clone https://github.com/<your-user>/e3cli.git
+cd e3cli
+make dev                    # pip install -e ".[dev]"
+
+# Run linter
+make lint
+
+# Run tests
+make test
+
+# Build distribution
+make build
+```
+
+---
+
+## Roadmap
+
+- [ ] AI-powered material summarization (`e3cli ai summarize`)
+- [ ] AI-assisted assignment drafting (`e3cli ai draft`)
+- [ ] Smart deadline notifications with priority scoring
+- [ ] Desktop notification integration (Linux `notify-send`, macOS `osascript`)
+- [ ] Course filtering by semester
+- [ ] Parallel downloads for faster sync
+
+---
+
+## License
+
+MIT