take-note-cli 1.2.1__tar.gz → 2.0.0__tar.gz

{take_note_cli-1.2.1 → take_note_cli-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: take-note-cli
-Version: 1.2.1
+Version: 2.0.0
 Summary: Create and open notes in your favourite editor.
 Home-page: https://github.com/wsinned/take-note
 License: MIT
@@ -21,27 +21,33 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Utilities
+Requires-Dist: confuse (>=2.0,<3.0)
 Project-URL: Repository, https://github.com/wsinned/take-note
 Description-Content-Type: text/markdown
 
 # Take Note
 
-**Create and open notes in your favourite editor.**
+**Create, organise and open notes in your favourite editor.**
+
+I like having a quick, reliable and repeatable way of taking notes. If I have to open an editor, nvigate to the correct file, or create one in the correct place when it doesn't exist, then I find that I end up taking notes in random places. With Take Note, I have a few simple aliases set up so that typing thisWeek in my shell gets me to the right place in my DropBox with a new file if needed, created from a template so that eveything is consistent. This really scratches my itch. If it works for you great! If not, create your own solution.
 
 ## Features
 
-- Written in Python with no runtime dependencies.
-  - Works on Python 3.8 - 3.11.
+- Written in Python with minimal runtime dependencies. Initially there were none, but I recently added Confuse (in v2.0.0) to allow a config file to do some of the heavy lifting that made aliases cumbersome.
+  - Works on Python 3.8 - 3.12.
 - Open notes files for specified week using the `code` command line for VS Code.
   - --thisWeek, --lastWeek and --nextWeek are supported.
 - Organises notes in a date based folder structure from your root notes folder, e.g. 2023/08
-  - The default folder is $HOME/Notes
+  - The default folder is $HOME/Notes. I prefer to keep them in Google Drive or DropBox so I can access from mobile, tablet or my spare laptop.
   - set the root notes folder using --notesFolder
 - Choose which editor to use with --editor
 - Specify a VS Code workspace to open along with the note file with --workspace
-  - This will override the --editor setting to `code`
+  - This will automatically override the --editor setting to `code`. I have my default workspace set up with:
+    - Zen mode
+    - Word wrap
 - Specify a template file relative to the root notes folder to use when a new file is created using --template. This also performs a simple replacement of the text HEADER_DATE with the date formatted as "%A %d %B %Y" to use in the document title.
 - Support for batch creation of files in advance. This is useful if you use a device where you can edit files, but can't easily create them. Use --batch 5 along with any of the --*Week options to create that week and the following 4 weeks too.
+- Config file allows base options to be set and reduce command line arguments needed.
 
 ## Future features
 
@@ -63,9 +69,23 @@ pipx install git+https://github.com/wsinned/take-note
 
 ## Usage
 
+### Config File
+
+A basic config file will be created in ~/.config/TakeNote/config.yaml if it doesn't already exist. Specifying default values here simplifies use of the command line by reducing the number of options needed to be supplied or added to an alias.
+
+#### Config File Default Options
+
+- notesFolder: Notes
+- editor: code
+- workspace:
+- template:
+- batch:
+- verbose: False
+
 ### Command Line
 
-Specify a folder using the --notesFolder option, otherwise $HOME/Notes will be used
+Command line arguments will override any specified in the config file.
+Specify a folder using the --notesFolder option.
 A week option must be supplied from --thisWeek, --lastWeek or --nextWeek
 
 ```bash
@@ -137,6 +157,9 @@ ruff . --config pyproject.toml
 # run the tests without activating a shell
 poetry run pytest
 
+# run the installed app
+poetry run take-note-cli --thisWeek
+
 # exit the shell
 exit
 ```
@@ -153,7 +176,7 @@ poetry run ruff . --config pyproject.toml
 
 From an installed and tested venv, do the following:
 
-Bump the version inpyproject.tom
+Bump the version in pyproject.toml
 
 ```bash
 # build the package

{take_note_cli-1.2.1 → take_note_cli-2.0.0}/README.md

@@ -1,21 +1,26 @@
 # Take Note
 
-**Create and open notes in your favourite editor.**
+**Create, organise and open notes in your favourite editor.**
+
+I like having a quick, reliable and repeatable way of taking notes. If I have to open an editor, nvigate to the correct file, or create one in the correct place when it doesn't exist, then I find that I end up taking notes in random places. With Take Note, I have a few simple aliases set up so that typing thisWeek in my shell gets me to the right place in my DropBox with a new file if needed, created from a template so that eveything is consistent. This really scratches my itch. If it works for you great! If not, create your own solution.
 
 ## Features
 
-- Written in Python with no runtime dependencies.
-  - Works on Python 3.8 - 3.11.
+- Written in Python with minimal runtime dependencies. Initially there were none, but I recently added Confuse (in v2.0.0) to allow a config file to do some of the heavy lifting that made aliases cumbersome.
+  - Works on Python 3.8 - 3.12.
 - Open notes files for specified week using the `code` command line for VS Code.
   - --thisWeek, --lastWeek and --nextWeek are supported.
 - Organises notes in a date based folder structure from your root notes folder, e.g. 2023/08
-  - The default folder is $HOME/Notes
+  - The default folder is $HOME/Notes. I prefer to keep them in Google Drive or DropBox so I can access from mobile, tablet or my spare laptop.
   - set the root notes folder using --notesFolder
 - Choose which editor to use with --editor
 - Specify a VS Code workspace to open along with the note file with --workspace
-  - This will override the --editor setting to `code`
+  - This will automatically override the --editor setting to `code`. I have my default workspace set up with:
+    - Zen mode
+    - Word wrap
 - Specify a template file relative to the root notes folder to use when a new file is created using --template. This also performs a simple replacement of the text HEADER_DATE with the date formatted as "%A %d %B %Y" to use in the document title.
 - Support for batch creation of files in advance. This is useful if you use a device where you can edit files, but can't easily create them. Use --batch 5 along with any of the --*Week options to create that week and the following 4 weeks too.
+- Config file allows base options to be set and reduce command line arguments needed.
 
 ## Future features
 
@@ -37,9 +42,23 @@ pipx install git+https://github.com/wsinned/take-note
 
 ## Usage
 
+### Config File
+
+A basic config file will be created in ~/.config/TakeNote/config.yaml if it doesn't already exist. Specifying default values here simplifies use of the command line by reducing the number of options needed to be supplied or added to an alias.
+
+#### Config File Default Options
+
+- notesFolder: Notes
+- editor: code
+- workspace:
+- template:
+- batch:
+- verbose: False
+
 ### Command Line
 
-Specify a folder using the --notesFolder option, otherwise $HOME/Notes will be used
+Command line arguments will override any specified in the config file.
+Specify a folder using the --notesFolder option.
 A week option must be supplied from --thisWeek, --lastWeek or --nextWeek
 
 ```bash
@@ -111,6 +130,9 @@ ruff . --config pyproject.toml
 # run the tests without activating a shell
 poetry run pytest
 
+# run the installed app
+poetry run take-note-cli --thisWeek
+
 # exit the shell
 exit
 ```
@@ -127,7 +149,7 @@ poetry run ruff . --config pyproject.toml
 
 From an installed and tested venv, do the following:
 
-Bump the version inpyproject.tom
+Bump the version in pyproject.toml
 
 ```bash
 # build the package

{take_note_cli-1.2.1 → take_note_cli-2.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "take-note-cli"
-version = "1.2.1"
+version = "2.0.0"
 description = "Create and open notes in your favourite editor."
 license = "MIT"
 authors = [
@@ -27,6 +27,7 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.8"
+confuse = "^2.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.3"

take_note_cli-2.0.0/src/take_note_cli/config/config.yaml

@@ -0,0 +1,6 @@
+notesFolder: Notes
+editor: code
+workspace:
+template:
+batch:
+verbose: False

{take_note_cli-1.2.1 → take_note_cli-2.0.0}/src/take_note_cli/core/notes.py

@@ -12,6 +12,7 @@ from take_note_cli.utils.dates import (
     get_weeks_delta,
 )
 from take_note_cli.utils.args import process_args
+from take_note_cli.utils.config import process_config
 from subprocess import call
 
 
@@ -48,22 +49,26 @@ def get_path_for_file(week: date, folder_path):
 
 
 def create_batch_of_files(options, week, template_path):
+    verbose = options["verbose"]
+    batch = options["batch"]
+    notesFolder = options["notesFolder"]
     initial_note_path = None
-    if options.batch is not None:
-        for i in range(options.batch):
+
+    if batch is not None:
+        for i in range(batch):
             batch_week = week + get_weeks_delta(i)
-            note_path, file_exists = get_path_for_file(batch_week, options.notesFolder)
+            note_path, file_exists = get_path_for_file(batch_week, notesFolder)
             if i == 0:
                 initial_note_path = note_path
 
             if not file_exists:
-                if options.verbose:
+                if verbose:
                     print(f"Creating file: {note_path}")
                 create_file(note_path, template_path, batch_week)
     else:
-        initial_note_path, file_exists = get_path_for_file(week, options.notesFolder)
+        initial_note_path, file_exists = get_path_for_file(week, notesFolder)
         if not file_exists:
-            if options.verbose:
+            if verbose:
                 print(f"Creating file: {initial_note_path}")
             create_file(initial_note_path, template_path, week)
 
@@ -84,17 +89,26 @@ def open_file(folder_path, editor, note_file, verbose, workspace=None):
 def main(argv):
     template_path = None
     options, parser = process_args(argv)
+    config = process_config(options)
 
-    if options.verbose:
+    if config["verbose"]:
         print("Welcome to take-note-cli")
         print(options)
 
     delta = calculate_week_offset(options, parser)
     week = get_monday(date.today()) + delta
 
-    if options.template is not None:
-        template_path = generate_template_path(options.notesFolder, options.template)
+    if config["template"] is not None:
+        template_path = generate_template_path(
+            config["notesFolder"], config["template"]
+        )
 
-    note_path = create_batch_of_files(options, week, template_path)
+    note_path = create_batch_of_files(config, week, template_path)
 
-    open_file(options.notesFolder, options.editor, note_path, options.verbose, options.workspace)
+    open_file(
+        config["notesFolder"],
+        config["editor"],
+        note_path,
+        config["verbose"],
+        config["workspace"],
+    )

{take_note_cli-1.2.1 → take_note_cli-2.0.0}/src/take_note_cli/utils/args.py

@@ -1,5 +1,4 @@
 import argparse
-import pathlib
 import importlib.metadata
 
 __version__ = importlib.metadata.version("take-note-cli")
@@ -24,8 +23,7 @@ def init_argparse() -> argparse.ArgumentParser:
     )
     parser.add_argument(
         "--notesFolder",
-        default=pathlib.Path.home().joinpath("Notes"),
-        type=pathlib.Path,
+        default=None,
         help="""The root path for the notes folder. 
         If not supplied this defaults to the Notes
          folder in the users home folder.""",
@@ -83,7 +81,4 @@ def process_args(args):
     parser = init_argparse()
     options = parser.parse_args(args)
 
-    if options.workspace is not None:
-        options.editor = "code"
-
     return options, parser

take_note_cli-2.0.0/src/take_note_cli/utils/config.py

@@ -0,0 +1,42 @@
+import pathlib
+import confuse
+
+template = {
+    "notesFolder": confuse.Path(cwd=pathlib.Path.home()),
+    "editor": "code",
+    "workspace": None,
+    "template": None,
+    "batch": None,
+    "verbose": False,
+}
+
+
+def check_for_config_file():
+    config = confuse.Configuration("TakeNote")
+
+    if not config.keys():
+        config_filename = pathlib.Path.joinpath(
+            pathlib.Path(config.config_dir()), confuse.CONFIG_FILENAME
+        )
+
+        template_filename = pathlib.Path("./src/take_note_cli/config/config.yaml")
+
+        with open(template_filename, "r") as t:
+            with open(config_filename, "w") as f:
+                f.writelines(t.readlines())
+
+        config = check_for_config_file()
+
+    return config
+
+
+def process_config(options):
+    config = check_for_config_file()
+    config.set_args(options)
+    valid_config = config.get(template)
+
+    workspace = config["workspace"].get(confuse.Optional(confuse.String()))
+    if workspace is not None:
+        options.editor = "code"
+
+    return valid_config