passvault-cli 0.1.0__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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: passvault-cli
3
- Version: 0.1.0
3
+ Version: 0.1.2
4
4
  Summary: A local, encrypted, offline password manager CLI.
5
5
  Project-URL: Homepage, https://github.com/Ajeet2005/passvault
6
6
  Project-URL: Repository, https://github.com/Ajeet2005/passvault
@@ -91,13 +91,43 @@ we never return garbage plaintext.
91
91
 
92
92
  ## Install
93
93
 
94
- From PyPI:
94
+ ### Option 1 — pipx (recommended)
95
+
96
+ [pipx](https://pipx.pypa.io/) installs CLI tools in isolated environments and
97
+ puts their commands on your PATH. This is the best way to install `passvault`,
98
+ and it avoids the Windows "`passvault` is not recognized" problem entirely:
99
+
100
+ ```bash
101
+ # install pipx if you don't have it
102
+ python -m pip install --user pipx
103
+ python -m pipx ensurepath # adds pipx's bin dir to PATH; restart your terminal after
104
+
105
+ # then install passvault
106
+ pipx install passvault-cli
107
+ passvault init
108
+ ```
109
+
110
+ ### Option 2 — pip
95
111
 
96
112
  ```bash
97
113
  pip install passvault-cli
98
114
  ```
99
115
 
100
- Or from source:
116
+ > **Windows note:** with a plain `pip install`, the `passvault.exe` launcher
117
+ > lands in your Python `Scripts\` directory (e.g.
118
+ > `...\Python313\Scripts\`), which is often **not** on your PATH — so running
119
+ > `passvault` gives "command not found" / "is not recognized". Either:
120
+ >
121
+ > 1. add that `Scripts\` directory to your PATH, or
122
+ > 2. skip PATH entirely and run the CLI as a module:
123
+ >
124
+ > ```bash
125
+ > python -m passvault init
126
+ > ```
127
+ >
128
+ > The `-m` form works with every install method, on every OS.
129
+
130
+ ### Option 3 — from source
101
131
 
102
132
  ```bash
103
133
  git clone https://github.com/Ajeet2005/passvault.git
@@ -112,6 +142,9 @@ Requires Python 3.10+.
112
142
 
113
143
  ## Usage
114
144
 
145
+ All commands below also work as `python -m passvault <command>` if the
146
+ `passvault` command itself is not on your PATH.
147
+
115
148
  ### Create a vault
116
149
 
117
150
  ```bash
@@ -208,4 +241,4 @@ battle-tested password manager.
208
241
 
209
242
  ## License
210
243
 
211
- MIT — see [LICENSE](LICENSE).
244
+ MIT — see [LICENSE](https://github.com/Ajeet2005/passvault/blob/main/LICENSE).
@@ -34,13 +34,43 @@ we never return garbage plaintext.
34
34
 
35
35
  ## Install
36
36
 
37
- From PyPI:
37
+ ### Option 1 — pipx (recommended)
38
+
39
+ [pipx](https://pipx.pypa.io/) installs CLI tools in isolated environments and
40
+ puts their commands on your PATH. This is the best way to install `passvault`,
41
+ and it avoids the Windows "`passvault` is not recognized" problem entirely:
42
+
43
+ ```bash
44
+ # install pipx if you don't have it
45
+ python -m pip install --user pipx
46
+ python -m pipx ensurepath # adds pipx's bin dir to PATH; restart your terminal after
47
+
48
+ # then install passvault
49
+ pipx install passvault-cli
50
+ passvault init
51
+ ```
52
+
53
+ ### Option 2 — pip
38
54
 
39
55
  ```bash
40
56
  pip install passvault-cli
41
57
  ```
42
58
 
43
- Or from source:
59
+ > **Windows note:** with a plain `pip install`, the `passvault.exe` launcher
60
+ > lands in your Python `Scripts\` directory (e.g.
61
+ > `...\Python313\Scripts\`), which is often **not** on your PATH — so running
62
+ > `passvault` gives "command not found" / "is not recognized". Either:
63
+ >
64
+ > 1. add that `Scripts\` directory to your PATH, or
65
+ > 2. skip PATH entirely and run the CLI as a module:
66
+ >
67
+ > ```bash
68
+ > python -m passvault init
69
+ > ```
70
+ >
71
+ > The `-m` form works with every install method, on every OS.
72
+
73
+ ### Option 3 — from source
44
74
 
45
75
  ```bash
46
76
  git clone https://github.com/Ajeet2005/passvault.git
@@ -55,6 +85,9 @@ Requires Python 3.10+.
55
85
 
56
86
  ## Usage
57
87
 
88
+ All commands below also work as `python -m passvault <command>` if the
89
+ `passvault` command itself is not on your PATH.
90
+
58
91
  ### Create a vault
59
92
 
60
93
  ```bash
@@ -151,4 +184,4 @@ battle-tested password manager.
151
184
 
152
185
  ## License
153
186
 
154
- MIT — see [LICENSE](LICENSE).
187
+ MIT — see [LICENSE](https://github.com/Ajeet2005/passvault/blob/main/LICENSE).
@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
5
5
  [project]
6
6
  # PyPI distribution name; the importable package remains `passvault`.
7
7
  name = "passvault-cli"
8
- version = "0.1.0"
8
+ version = "0.1.2"
9
9
  description = "A local, encrypted, offline password manager CLI."
10
10
  readme = "README.md"
11
11
  requires-python = ">=3.10"
@@ -2,6 +2,6 @@
2
2
 
3
3
  from __future__ import annotations
4
4
 
5
- __version__ = "0.1.0"
5
+ __version__ = "0.1.2"
6
6
 
7
7
  __all__ = ["__version__"]
@@ -0,0 +1,14 @@
1
+ """Allow running the CLI as ``python -m passvault``.
2
+
3
+ Handy when the ``passvault`` console script is not on your PATH — a common
4
+ situation with a plain ``pip install`` on Windows, where the launcher lands in
5
+ the Python ``Scripts\\`` directory. This module makes the invocation work
6
+ regardless of how the package was installed.
7
+ """
8
+
9
+ from __future__ import annotations
10
+
11
+ from .cli import app
12
+
13
+ if __name__ == "__main__":
14
+ app()
@@ -182,4 +182,4 @@ def test_generate_invalid_length_errors(vault_file, prompts):
182
182
  def test_version(vault_file):
183
183
  result = runner.invoke(cli.app, ["--version"])
184
184
  assert result.exit_code == 0
185
- assert "0.1.0" in result.output
185
+ assert "0.1.2" in result.output
File without changes
File without changes