exist-shell 0.1.1__tar.gz → 0.1.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. {exist_shell-0.1.1 → exist_shell-0.1.2}/CHANGELOG.md +6 -0
  2. {exist_shell-0.1.1 → exist_shell-0.1.2}/PKG-INFO +24 -2
  3. {exist_shell-0.1.1 → exist_shell-0.1.2}/README.md +23 -1
  4. {exist_shell-0.1.1 → exist_shell-0.1.2}/docs/api.md +8 -0
  5. {exist_shell-0.1.1 → exist_shell-0.1.2}/docs/index.md +1 -1
  6. {exist_shell-0.1.1 → exist_shell-0.1.2}/docs/installation.md +24 -2
  7. {exist_shell-0.1.1 → exist_shell-0.1.2}/pyproject.toml +1 -1
  8. {exist_shell-0.1.1 → exist_shell-0.1.2}/uv.lock +1 -1
  9. {exist_shell-0.1.1 → exist_shell-0.1.2}/.gitguardian.yaml +0 -0
  10. {exist_shell-0.1.1 → exist_shell-0.1.2}/.github/dependabot.yml +0 -0
  11. {exist_shell-0.1.1 → exist_shell-0.1.2}/.github/workflows/docs.yml +0 -0
  12. {exist_shell-0.1.1 → exist_shell-0.1.2}/.github/workflows/e2e.yml +0 -0
  13. {exist_shell-0.1.1 → exist_shell-0.1.2}/.github/workflows/release.yml +0 -0
  14. {exist_shell-0.1.1 → exist_shell-0.1.2}/.github/workflows/ruff.yml +0 -0
  15. {exist_shell-0.1.1 → exist_shell-0.1.2}/.github/workflows/tests.yml +0 -0
  16. {exist_shell-0.1.1 → exist_shell-0.1.2}/.github/workflows/ty.yml +0 -0
  17. {exist_shell-0.1.1 → exist_shell-0.1.2}/.gitignore +0 -0
  18. {exist_shell-0.1.1 → exist_shell-0.1.2}/CLAUDE.md +0 -0
  19. {exist_shell-0.1.1 → exist_shell-0.1.2}/LICENSE +0 -0
  20. {exist_shell-0.1.1 → exist_shell-0.1.2}/Makefile +0 -0
  21. {exist_shell-0.1.1 → exist_shell-0.1.2}/docs/commands.md +0 -0
  22. {exist_shell-0.1.1 → exist_shell-0.1.2}/docs/completion.md +0 -0
  23. {exist_shell-0.1.1 → exist_shell-0.1.2}/docs/configuration.md +0 -0
  24. {exist_shell-0.1.1 → exist_shell-0.1.2}/docs/development.md +0 -0
  25. {exist_shell-0.1.1 → exist_shell-0.1.2}/docs/sync.md +0 -0
  26. {exist_shell-0.1.1 → exist_shell-0.1.2}/mkdocs.yml +0 -0
  27. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/docker.sh +0 -0
  28. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/lib.sh +0 -0
  29. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T02_server.sh +0 -0
  30. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T03_collection.sh +0 -0
  31. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T04_ls.sh +0 -0
  32. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T05_put.sh +0 -0
  33. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T06_ls_after.sh +0 -0
  34. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T07_cat.sh +0 -0
  35. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T08_cp.sh +0 -0
  36. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T09_rm.sh +0 -0
  37. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T10_mkdir.sh +0 -0
  38. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T11_edit.sh +0 -0
  39. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T12_sync.sh +0 -0
  40. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T13_mv.sh +0 -0
  41. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T14_exec.sh +0 -0
  42. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T15_user.sh +0 -0
  43. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T16_group.sh +0 -0
  44. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T17_chown.sh +0 -0
  45. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e/sections/T18_chmod.sh +0 -0
  46. {exist_shell-0.1.1 → exist_shell-0.1.2}/scripts/e2e.sh +0 -0
  47. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/__init__.py +0 -0
  48. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/cache.py +0 -0
  49. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/client/__init__.py +0 -0
  50. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/client/_base.py +0 -0
  51. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/client/_collections.py +0 -0
  52. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/client/_documents.py +0 -0
  53. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/client/_groups.py +0 -0
  54. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/client/_permissions.py +0 -0
  55. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/client/_queries.py +0 -0
  56. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/client/_users.py +0 -0
  57. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/__init__.py +0 -0
  58. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/cat.py +0 -0
  59. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/chmod.py +0 -0
  60. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/chown.py +0 -0
  61. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/collection.py +0 -0
  62. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/cp.py +0 -0
  63. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/edit.py +0 -0
  64. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/exec.py +0 -0
  65. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/group.py +0 -0
  66. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/ls.py +0 -0
  67. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/mkdir.py +0 -0
  68. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/mv.py +0 -0
  69. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/put.py +0 -0
  70. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/rm.py +0 -0
  71. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/server.py +0 -0
  72. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/sync.py +0 -0
  73. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/commands/user.py +0 -0
  74. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/completions.py +0 -0
  75. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/config.py +0 -0
  76. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/exceptions.py +0 -0
  77. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/main.py +0 -0
  78. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/models.py +0 -0
  79. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/utils.py +0 -0
  80. {exist_shell-0.1.1 → exist_shell-0.1.2}/src/exist_shell/xquery.py +0 -0
  81. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/__init__.py +0 -0
  82. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/conftest.py +0 -0
  83. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_cache.py +0 -0
  84. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_client.py +0 -0
  85. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_cat.py +0 -0
  86. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_chmod.py +0 -0
  87. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_chown.py +0 -0
  88. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_collection.py +0 -0
  89. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_cp.py +0 -0
  90. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_edit.py +0 -0
  91. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_exec.py +0 -0
  92. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_group.py +0 -0
  93. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_ls.py +0 -0
  94. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_mkdir.py +0 -0
  95. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_mv.py +0 -0
  96. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_put.py +0 -0
  97. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_rm.py +0 -0
  98. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_server.py +0 -0
  99. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_sync.py +0 -0
  100. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_commands_user.py +0 -0
  101. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_completions.py +0 -0
  102. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_config.py +0 -0
  103. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_utils.py +0 -0
  104. {exist_shell-0.1.1 → exist_shell-0.1.2}/tests/test_xquery.py +0 -0
@@ -2,6 +2,12 @@
2
2
 
3
3
  ## unreleased
4
4
 
5
+ ## 0.1.2 - 2026-06-23
6
+
7
+ ### Documentation
8
+
9
+ - Document installing `exsh` from PyPI (`uv tool install`, `pipx install`, `uvx --from`); the existing `git+https://...` instructions are kept as an alternative for tracking unreleased commits
10
+
5
11
  ## 0.1.1 - 2026-06-23
6
12
 
7
13
  ### Fixes
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: exist-shell
3
- Version: 0.1.1
3
+ Version: 0.1.2
4
4
  Summary: Command-line tool to interact with eXist-db via REST
5
5
  Project-URL: Homepage, https://github.com/ambs/exist-shell
6
6
  Project-URL: Repository, https://github.com/ambs/exist-shell
@@ -50,7 +50,13 @@ A command-line tool to interact with an [eXist-db](https://exist-db.org) server
50
50
  Install system-wide with `uv tool`:
51
51
 
52
52
  ```bash
53
- uv tool install git+https://github.com/ambs/exist-shell
53
+ uv tool install exist-shell
54
+ ```
55
+
56
+ Or with `pipx`:
57
+
58
+ ```bash
59
+ pipx install exist-shell
54
60
  ```
55
61
 
56
62
  This places `exsh` on your `PATH`. Verify with:
@@ -65,6 +71,22 @@ To uninstall:
65
71
  uv tool uninstall exist-shell
66
72
  ```
67
73
 
74
+ ### Run without installing
75
+
76
+ ```bash
77
+ uvx --from exist-shell exsh --version
78
+ ```
79
+
80
+ `uvx` fetches the package into a temporary, cached environment and runs it — handy for one-off use or trying out a new release.
81
+
82
+ ### Install from git
83
+
84
+ To track an unreleased commit instead of a PyPI release:
85
+
86
+ ```bash
87
+ uv tool install git+https://github.com/ambs/exist-shell
88
+ ```
89
+
68
90
  ## Configuration
69
91
 
70
92
  ### Add a server
@@ -19,7 +19,13 @@ A command-line tool to interact with an [eXist-db](https://exist-db.org) server
19
19
  Install system-wide with `uv tool`:
20
20
 
21
21
  ```bash
22
- uv tool install git+https://github.com/ambs/exist-shell
22
+ uv tool install exist-shell
23
+ ```
24
+
25
+ Or with `pipx`:
26
+
27
+ ```bash
28
+ pipx install exist-shell
23
29
  ```
24
30
 
25
31
  This places `exsh` on your `PATH`. Verify with:
@@ -34,6 +40,22 @@ To uninstall:
34
40
  uv tool uninstall exist-shell
35
41
  ```
36
42
 
43
+ ### Run without installing
44
+
45
+ ```bash
46
+ uvx --from exist-shell exsh --version
47
+ ```
48
+
49
+ `uvx` fetches the package into a temporary, cached environment and runs it — handy for one-off use or trying out a new release.
50
+
51
+ ### Install from git
52
+
53
+ To track an unreleased commit instead of a PyPI release:
54
+
55
+ ```bash
56
+ uv tool install git+https://github.com/ambs/exist-shell
57
+ ```
58
+
37
59
  ## Configuration
38
60
 
39
61
  ### Add a server
@@ -4,6 +4,14 @@
4
4
 
5
5
  ## Installation
6
6
 
7
+ ```bash
8
+ pip install exist-shell
9
+ # or with uv
10
+ uv add exist-shell
11
+ ```
12
+
13
+ To track an unreleased commit instead of a PyPI release:
14
+
7
15
  ```bash
8
16
  pip install git+https://github.com/ambs/exist-shell
9
17
  # or with uv
@@ -21,7 +21,7 @@
21
21
 
22
22
  ```bash
23
23
  # 1. Install
24
- uv tool install git+https://github.com/ambs/exist-shell
24
+ uv tool install exist-shell
25
25
 
26
26
  # 2. Register your server
27
27
  exsh server add localhost --port 8080 --user admin
@@ -7,10 +7,16 @@
7
7
 
8
8
  ## Install as a tool
9
9
 
10
- The recommended way is to install `exsh` as a uv tool so it is available system-wide:
10
+ The recommended way is to install `exsh` from PyPI as a uv tool so it is available system-wide:
11
11
 
12
12
  ```bash
13
- uv tool install git+https://github.com/ambs/exist-shell
13
+ uv tool install exist-shell
14
+ ```
15
+
16
+ Or with `pipx`:
17
+
18
+ ```bash
19
+ pipx install exist-shell
14
20
  ```
15
21
 
16
22
  Verify the installation:
@@ -19,6 +25,14 @@ Verify the installation:
19
25
  exsh --version
20
26
  ```
21
27
 
28
+ ## Run without installing
29
+
30
+ ```bash
31
+ uvx --from exist-shell exsh --version
32
+ ```
33
+
34
+ `uvx` runs the command in a temporary, cached environment without installing it permanently — useful for trying out `exsh` or running a one-off command.
35
+
22
36
  ## Upgrade
23
37
 
24
38
  ```bash
@@ -31,6 +45,14 @@ uv tool upgrade exist-shell
31
45
  uv tool uninstall exist-shell
32
46
  ```
33
47
 
48
+ ## Install from git
49
+
50
+ To install an unreleased commit instead of the latest PyPI release:
51
+
52
+ ```bash
53
+ uv tool install git+https://github.com/ambs/exist-shell
54
+ ```
55
+
34
56
  ## Install from a local clone
35
57
 
36
58
  If you want to develop or test from source:
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "exist-shell"
7
- version = "0.1.1"
7
+ version = "0.1.2"
8
8
  description = "Command-line tool to interact with eXist-db via REST"
9
9
  readme = "README.md"
10
10
  license = "MIT"
@@ -157,7 +157,7 @@ toml = [
157
157
 
158
158
  [[package]]
159
159
  name = "exist-shell"
160
- version = "0.1.1"
160
+ version = "0.1.2"
161
161
  source = { editable = "." }
162
162
  dependencies = [
163
163
  { name = "httpx" },
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes