SIYUAN-1 - trckr

← SIYUAN-1

feature

Created: 2026-02-02 • Updated: 2026-02-02

Relationships Loading...

Set up project structure with SiyuanClient class, CLI entry point, decorators, output formatting, and pytest infrastructure.

## Implementation
- `pyproject.toml` with dependencies (click>=8.1, requests>=2.31, pyyaml>=6.0) and dev deps (pytest, pytest-mock, responses)
- `Makefile` with targets: `install`, `test`, `test-integration`
- `SiyuanClient` class with `_request()` method handling POST + Authorization header
- CLI entry point with `--url`, `--token`, `--format` global options
- `@with_client` and `@format_option` decorators
- `print_output()` and `format_table()` utilities
- `siyuan ping` and `siyuan system version/time/boot` commands
- `tests/conftest.py` with fixtures (mock client, mock responses)
- `tests/test_client.py` scaffold with unit test patterns
- Integration test marker `@pytest.mark.integration`

## File Structure
```
siyuan-cli/
├── siyuan.py
├── pyproject.toml
├── Makefile
├── tests/
│   ├── conftest.py
│   ├── test_client.py
│   └── integration/
│       ├── conftest.py
│       └── test_live.py
```

## QA Instructions
1. Run `make install` - must succeed
2. Run `make test` - must pass (mocked tests)
3. Run `siyuan --help` - must show usage
4. Run `siyuan ping` against siyuan.roboalch.com - must succeed
5. Run `siyuan system version` - must return version string
6. Run `make test-integration` with SIYUAN_TOKEN set - must pass

Pull Requests (comma-separated URLs)

Attachments

Comments (2)

agent · 2026-02-02

## Implementation Complete **Files Created:** - `siyuan.py` (224 lines) - Main CLI with SiyuanClient class - `pyproject.toml` - Dependencies and project metadata - `Makefile` - Build targets (install, test, test-integration) - `.gitignore` - Standard Python gitignore - `tests/conftest.py` - Shared test fixtures - `tests/test_client.py` - 25 unit tests with mocked responses - `tests/integration/conftest.py` - Integration test fixtures - `tests/integration/test_live.py` - 9 live API tests **Features Implemented:** - `SiyuanClient` class with `_request()` handling POST + Authorization header - CLI entry point with `--url`, `--token`, `--format` global options - `@with_client` and `@format_option` decorators - `print_output()` and `format_table()` utilities - Commands: `siyuan ping`, `siyuan system version/time/boot` **Verification:** 1. `make install` - SUCCESS 2. `make test` - 25 tests passed 3. `siyuan --help` - Shows proper usage 4. `siyuan ping --url https://siyuan.roboalch.com --token dummy` - "Connected" 5. `siyuan system version --url https://siyuan.roboalch.com --token dummy` - Returns "3.4.2" 6. `make test-integration` with SIYUAN_TOKEN set - 9 tests passed **Commit:** 1f331fc - Merged to main and pushed to Gitea

triage-agent · 2026-02-02

## Feature Triage Complete **Status:** NOT IMPLEMENTED **Summary:** Project directory is essentially empty - no Python files, pyproject.toml, Makefile, or tests exist. This is a greenfield implementation. **Implementation Location:** - `siyuan.py` - Main CLI and SiyuanClient class - `pyproject.toml` - Dependencies (click, requests, pyyaml) and metadata - `Makefile` - Build targets - `tests/` - Pytest infrastructure **Reference Pattern:** Follow jopctl (~/github/jopctl/jopctl.py) which uses identical tech stack and decorator patterns. **Key API Findings:** - SiYuan uses POST for all endpoints - Auth via `Authorization: Token xxx` header - Response format: `{"code": 0, "msg": "", "data": {}}` - System endpoints: `/api/system/getSystemVersion`, `/api/system/getCurrentTime`, `/api/system/getBootProgress` **Complexity:** Medium See /tmp/triage-SIYUAN-1.md for full triage report.