take-note-cli 2.1.4__tar.gz → 2.1.5__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.1
2
2
  Name: take-note-cli
3
- Version: 2.1.4
3
+ Version: 2.1.5
4
4
  Summary: Create and open notes in your favourite editor.
5
5
  Home-page: https://github.com/wsinned/take-note
6
6
  License: MIT
@@ -60,6 +60,7 @@ Support for opening using [Obsidian application uris](https://help.obsidian.md/E
60
60
  xdg-open "obsidian://open?path=/home/wsinned/Documents/Personal/WorkNotes/2024/11/2024-11-11-Weekly-log.md
61
61
 
62
62
  ```
63
+
63
64
  This handler opens the vault 'Personal' and the note file in the WorkNotes/2024/11/ folder of the vault.
64
65
 
65
66
  The command called adapts according to `sys.platform` e.g. `open`, `start` or `xdg-open`.
@@ -189,14 +190,25 @@ poetry run ruff . --config pyproject.toml
189
190
 
190
191
  ## Build & Publish
191
192
 
192
- From an installed and tested venv, do the following:
193
+ ### Automated Way
193
194
 
194
- Bump the version in pyproject.toml
195
+ Test, build and publish are now completed from a GitHub workflow. The workflow is triggered by pushing a tagged branch `v*` to GitHub.
195
196
 
196
197
  ```bash
197
- # build the package
198
- poetry build
198
+ poetry version |patch|minor|major|
199
+ git add pyproject.toml
200
+ git commit -m "Release v2.1.4"
201
+ git tag -a "v2.1.4" -m "Release v2.1.4"
202
+ pit push --tag origin HEAD
203
+ ```
204
+
205
+ The workflow will run and complete publishing.
206
+
207
+ ### Old Manual Way
199
208
 
209
+ As above, but after pushing
210
+
211
+ ```bash
200
212
  # ensure your pypi token is registered with Poetry
201
213
  poetry config pypi-token.pypi <fresh-token>
202
214
 
@@ -204,5 +216,3 @@ poetry config pypi-token.pypi <fresh-token>
204
216
  poetry publish
205
217
  ```
206
218
 
207
- TODO: add poetry publishing to GitHub workflow
208
-
@@ -32,6 +32,7 @@ Support for opening using [Obsidian application uris](https://help.obsidian.md/E
32
32
  xdg-open "obsidian://open?path=/home/wsinned/Documents/Personal/WorkNotes/2024/11/2024-11-11-Weekly-log.md
33
33
 
34
34
  ```
35
+
35
36
  This handler opens the vault 'Personal' and the note file in the WorkNotes/2024/11/ folder of the vault.
36
37
 
37
38
  The command called adapts according to `sys.platform` e.g. `open`, `start` or `xdg-open`.
@@ -161,19 +162,28 @@ poetry run ruff . --config pyproject.toml
161
162
 
162
163
  ## Build & Publish
163
164
 
164
- From an installed and tested venv, do the following:
165
+ ### Automated Way
165
166
 
166
- Bump the version in pyproject.toml
167
+ Test, build and publish are now completed from a GitHub workflow. The workflow is triggered by pushing a tagged branch `v*` to GitHub.
167
168
 
168
169
  ```bash
169
- # build the package
170
- poetry build
170
+ poetry version |patch|minor|major|
171
+ git add pyproject.toml
172
+ git commit -m "Release v2.1.4"
173
+ git tag -a "v2.1.4" -m "Release v2.1.4"
174
+ pit push --tag origin HEAD
175
+ ```
176
+
177
+ The workflow will run and complete publishing.
178
+
179
+ ### Old Manual Way
171
180
 
181
+ As above, but after pushing
182
+
183
+ ```bash
172
184
  # ensure your pypi token is registered with Poetry
173
185
  poetry config pypi-token.pypi <fresh-token>
174
186
 
175
187
  # publish the package
176
188
  poetry publish
177
189
  ```
178
-
179
- TODO: add poetry publishing to GitHub workflow
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "take-note-cli"
3
- version = "2.1.4"
3
+ version = "2.1.5"
4
4
  description = "Create and open notes in your favourite editor."
5
5
  license = "MIT"
6
6
  authors = [
File without changes