Skip to content

Commit adf217b

Browse files
authored
Merge pull request #6 from kwrkb/claude/fix-documentation-alignment-DjsJA
docs: ドキュメントと設定ファイルの整合性を修正
2 parents d564d46 + ed19ef7 commit adf217b

File tree

12 files changed

+36
-157
lines changed

12 files changed

+36
-157
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ A lightweight, cross-platform PyQt6 desktop SQLite database viewer. The app lets
88

99
- Browse tables and view row data with pagination
1010
- Run custom SQL queries with syntax highlighting and CSV export
11+
- Execute write operations (INSERT, UPDATE, DELETE) and DDL (CREATE, DROP, ALTER)
12+
- Destructive query confirmation dialog for safety
13+
- Light/Dark theme switching (Ctrl+D) with persistent preference
14+
- Monospace font in SQL editor and schema view
15+
- Keyboard shortcuts: Ctrl+Enter / F5 (run query), Ctrl+R (refresh tables)
1116
- Display table schema metadata
1217
- Persistent recent files list for quick access
1318
- Debian package builder for Ubuntu (Python-dependent bundle)
@@ -89,12 +94,12 @@ sqliteview /path/to/database.sqlite
8994
## Running Tests
9095

9196
```bash
92-
pytest
97+
uv run python -m pytest tests/ -v
9398
```
9499

95100
## Packaging
96101

97-
- Build wheel + sdist: `python -m build`
102+
- Build wheel + sdist: `uv run python -m build`
98103
- Build Debian package: `./scripts/build_deb.sh`
99104
- Generated packages are placed in `dist/`
100105

README_ja.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@
88

99
- ページネーション付きでテーブルを閲覧し、行データを表示
1010
- シンタックスハイライトとCSVエクスポート機能を備えたカスタムSQLクエリの実行
11+
- 書き込み操作(INSERT, UPDATE, DELETE)およびDDL(CREATE, DROP, ALTER)の実行
12+
- 破壊的クエリの安全確認ダイアログ
13+
- ライト/ダークテーマの切替(Ctrl+D)と設定の永続化
14+
- SQLエディタ・スキーマ表示のモノスペースフォント
15+
- キーボードショートカット: Ctrl+Enter / F5(クエリ実行)、Ctrl+R(テーブルリフレッシュ)
1116
- テーブルスキーマのメタデータを表示
1217
- 素早いアクセスのための最近使用したファイル一覧の永続化
1318
- Ubuntu用のDebianパッケージビルダー(Python依存バンドル)
@@ -89,12 +94,12 @@ sqliteview /path/to/database.sqlite
8994
## テストの実行
9095

9196
```bash
92-
pytest
97+
uv run python -m pytest tests/ -v
9398
```
9499

95100
## パッケージング
96101

97-
- wheel + sdist のビルド: `python -m build`
102+
- wheel + sdist のビルド: `uv run python -m build`
98103
- Debian パッケージのビルド: `./scripts/build_deb.sh`
99104
- 生成されたパッケージは `dist/` に配置されます
100105

docs/architecture.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,19 @@
99
- Implements the main window, table browser, query editor, and result views using PyQt6 widgets.
1010
- Separates UI widgets from data access via signal/slot connections.
1111
3. **Data access layer (`sqliteviewer.database`)**
12-
- Provides `DatabaseService` for opening SQLite files, listing tables, describing schemas, executing queries, and streaming rows.
12+
- Provides `DatabaseService` for opening SQLite files, listing tables, describing schemas, executing queries (read and write), and streaming rows.
13+
- Supports DML (INSERT/UPDATE/DELETE), DDL (CREATE/DROP/ALTER), and TCL (BEGIN/COMMIT/ROLLBACK).
14+
- Includes query classification (`classify_query`) and destructive operation detection (`is_destructive_query`) with SQL noise stripping for safe keyword matching.
1315
- Includes pragmatic safeguards (e.g., limiting returned rows) to keep the UI responsive.
14-
4. **Utility module (`sqliteviewer.resources`)**
16+
4. **Theme system (`sqliteviewer.theme`)**
17+
- Manages light/dark theme switching via QSS stylesheets.
18+
- Persists user preference via `QSettings`.
19+
5. **SQL syntax highlighter (`sqliteviewer.sql_highlighter`)**
20+
- Provides real-time syntax highlighting for the query editor.
21+
- Supports theme-aware color schemes (light/dark).
22+
6. **Utility module (`sqliteviewer.resources`)**
1523
- Manages application metadata, version, and icon loading.
24+
- Includes QSS theme files (`light.qss`, `dark.qss`) and desktop integration assets.
1625

1726
## Data flow
1827

@@ -24,8 +33,8 @@ Results are translated into Qt models (`QStandardItemModel`) before reaching the
2433

2534
## Packaging & distribution
2635

27-
- Python packaging via `pyproject.toml` (setuptools backend).
28-
- CLI/desktop entry point exposed as `sqliteviewer` console script.
36+
- Python packaging via `pyproject.toml` (hatchling backend).
37+
- CLI/desktop entry point exposed as `sqliteview` console script.
2938
- Debian packaging script (`scripts/build_deb.sh`) leverages `python -m build` and `dpkg-deb` to produce `.deb` including bundled dependencies.
3039
- Desktop integration provides `.desktop` launcher and application icon installed by the Debian package.
3140

docs/assumptions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Assumptions for Ubuntu SQLite Viewer
1+
# Assumptions for SQLite View
22

3-
- Target platform is Ubuntu 22.04 LTS or newer with Python >= 3.10 preinstalled.
4-
- End users install the application on desktop environments where X11/Wayland is available for GUI rendering.
5-
- PyQt6 wheels are acceptable for bundling within the Debian package; no system Qt dependencies are required.
3+
- Primary target platforms are Ubuntu/Linux (primary development), Windows (confirmed working), and macOS (untested). Python >= 3.10 is required.
4+
- End users install the application on desktop environments where X11/Wayland (Linux) or native window system (Windows/macOS) is available for GUI rendering.
5+
- PyQt6 wheels are acceptable for bundling within the Debian package; no system Qt dependencies are required. On Windows, PyQt6 bundles all necessary dependencies.
66
- Users operate on local SQLite databases; remote connections are out of scope.
77
- Database files are expected to fit in memory for paging 1,000-row chunks; extremely large tables may require streaming in a future iteration.
8-
- Packaging leverages native Python tooling and `dpkg-deb`; `fpm` or other third-party packagers are not required on target systems.
8+
- Debian packaging leverages native Python tooling and `dpkg-deb`; `fpm` or other third-party packagers are not required on target systems.
99
- CI runs on GitHub-hosted Ubuntu runners with internet access to install Python dependencies.
10-
- Application internationalization/localization is not required for this release; English-only UI is acceptable.
10+
- UI is English-only. Japanese documentation (`README_ja.md`) is provided separately.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ dev = [
3939
]
4040

4141
[project.urls]
42-
Homepage = "https://example.com/sqliteviewer"
43-
Repository = "https://example.com/sqliteviewer/repo"
42+
Homepage = "https://github.com/kwrkb/SQLiteView"
43+
Repository = "https://github.com/kwrkb/SQLiteView"
4444

4545
[project.scripts]
4646
sqliteview = "sqliteviewer.__main__:main"

src/sqliteviewer.egg-info/PKG-INFO

Lines changed: 0 additions & 106 deletions
This file was deleted.

src/sqliteviewer.egg-info/SOURCES.txt

Lines changed: 0 additions & 23 deletions
This file was deleted.

src/sqliteviewer.egg-info/dependency_links.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/sqliteviewer.egg-info/entry_points.txt

Lines changed: 0 additions & 2 deletions
This file was deleted.

src/sqliteviewer.egg-info/requires.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)