e3cli 0.3.1__py3-none-any.whl

e3cli-0.3.1.dist-info/METADATA

@@ -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

e3cli-0.3.1.dist-info/RECORD

@@ -0,0 +1,36 @@
+e3cli/__init__.py,sha256=MBBBeDGindYTULoCuSMy0v9AoYhZjyJw4vQLWd_8VoA,74
+e3cli/__main__.py,sha256=urCBVMSA_KghtUSCjG5OUYVgW0i9fW3PuTfAP1y0Ouo,76
+e3cli/auth.py,sha256=JJldnoOZcDH12F3EZvMk1hZp5cdVN6yigN5-A4n-I_c,909
+e3cli/cli.py,sha256=7-rbq8dCHp7HCmysXaH3oaxaZ2XBc887mn533TWjHRg,1963
+e3cli/config.py,sha256=JFUV8B8F9W2-Tk5ZuWtcaWUw8aOqjVjq0cQdkJGl2ic,2787
+e3cli/credential.py,sha256=I650l7qfi0Z7srI03Cyus07qecdraUu0K0bxwuSuSz8,3746
+e3cli/i18n.py,sha256=b9BFIZVJ7_dTGRq9LBK7WT_fcFUmi3GWP06yWXH_9KI,11204
+e3cli/ai/__init__.py,sha256=L89yntHdvz1zBpUV6Hkye3ES1_hAl2jNEsHqqaQZmVg,40
+e3cli/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+e3cli/api/assignments.py,sha256=gTtWvmwC0xm-1NZG3FcFFb0A0PEg1Pd_WsT6QSrGSMk,1283
+e3cli/api/client.py,sha256=TUrV01RNY5HDVsyM-4h9r0jvbFPNkmCIrdCYhAtid1Q,2573
+e3cli/api/courses.py,sha256=qyuqQA13wW2f-__SONDPuaUONfJkltQ9goDC2c_FQUM,813
+e3cli/api/files.py,sha256=woNe7nKnVfd_2VEyRixvfr-HHWdqwsu3nsLVgdYFxD0,642
+e3cli/api/site.py,sha256=Kl60NBNR4I959FCDqeSTJp3YVnwZoUKuebt8AeW5Uv4,286
+e3cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+e3cli/commands/_common.py,sha256=NOmf4TS9Eni98nKcu2nGVObVbO-HU-_g-2gnxkeNPLs,747
+e3cli/commands/assignments.py,sha256=ciQvucc3WG9RA0O0A1f033GC48LQ-g-l6b3dbNSZDA8,2820
+e3cli/commands/courses.py,sha256=J5-nHsyC1ONx1hid21lCMaDuVtHWeGsD9KQZj7REG2E,1071
+e3cli/commands/download.py,sha256=Q01j8VGmdA8yjpdgA5j7aX6mdD4pNkW1rQlwoBOqPOI,3542
+e3cli/commands/login.py,sha256=z3WnzQqcwOL94odoqK1q9Bj4fzZkVG9IqAaEZ0_vA2I,2379
+e3cli/commands/logout.py,sha256=a3y0wvWuNazEJRApn-s72Lv3Gz8cJAYF-MO5FXMfGmY,406
+e3cli/commands/schedule.py,sha256=lFMjbmeDAY3GxuL07qbyia_DqdQKpLv1iIwMWmyDi2c,1080
+e3cli/commands/setup.py,sha256=M_8p70z-veagzsDz9D_q80X-VUfgyOmcDYt9dpZXr7s,4202
+e3cli/commands/submit.py,sha256=CpOBU0J3Rr-XkZGHY_XzSR7Y7CggoRFCo_ig5OmZijE,2588
+e3cli/commands/sync.py,sha256=Fjuba1bUDcn0Vml8WnD-Ys6bmsl052UGF0SxhQsKidc,3930
+e3cli/scheduler/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+e3cli/scheduler/cron.py,sha256=8O3ULg33hEYr_riqoSVA4ORYksD8Q_YrAFUrVS07j48,1631
+e3cli/storage/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+e3cli/storage/db.py,sha256=XnlWzZ41gZWFw7Qyq48JdTsZlec_2t84yvd8-THsQY4,4535
+e3cli/storage/models.py,sha256=lwe7ZosnZ7VSqH8zloiwfujAjNilGoL4GZ7GRSdevUg,513
+e3cli/storage/tracking.py,sha256=k1_SiZTFu5cbNppVh6Q4pRNkoUI_N_xsVqB_nFiIGkM,326
+e3cli-0.3.1.dist-info/METADATA,sha256=HliG1tPyk2bcJJ6LD6cFgS7v7GRGD5u-Z8n7v1Pv9Xc,10202
+e3cli-0.3.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+e3cli-0.3.1.dist-info/entry_points.txt,sha256=WKOiVUme-Hc-JrXxnzEp7rwu7HWINvUXh3uk5ucg4ew,40
+e3cli-0.3.1.dist-info/licenses/LICENSE,sha256=leNmCknvWNK9BAJr9lrNvGT0d9IiTwaDWdCUN1pKDvM,1075
+e3cli-0.3.1.dist-info/RECORD,,

e3cli-0.3.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

e3cli-0.3.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+e3cli = e3cli.cli:app

e3cli-0.3.1.dist-info/licenses/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.