take-note-cli 1.1.0__tar.gz → 1.2.0__tar.gz

{take-note-cli-1.1.0/src/take_note_cli.egg-info → take_note_cli-1.2.0}/PKG-INFO

@@ -1,34 +1,28 @@
 Metadata-Version: 2.1
 Name: take-note-cli
-Version: 1.1.0
+Version: 1.2.0
 Summary: Create and open notes in your favourite editor.
 Home-page: https://github.com/wsinned/take-note
+License: MIT
+Keywords: note,tool,utility,cli
 Author: wsinned
 Author-email: wsinned@tutanota.com
-Project-URL: Source, https://github.com/wsinned/take-note
-Keywords: note tool utility cli
+Requires-Python: >=3.8,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
-Classifier: Natural Language :: English
-Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Developers
-Classifier: Topic :: Utilities
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Requires-Python: <4,>=3.8
-Description-Content-Type: text/markdown; charset=UTF-8
-License-File: LICENSE
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: dateutils; extra == "test"
-Requires-Dist: black; extra == "test"
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Utilities
+Project-URL: Repository, https://github.com/wsinned/take-note
+Description-Content-Type: text/markdown
 
 # Take Note
 
@@ -161,6 +155,14 @@ venv/bin/pytest
 deactivate
 ```
 
+## Linting
+
+The project uses [ruff](https://github.com/charliermarsh/ruff) for linting and optionally for formatting.
+
+```bash
+venv/bin/ruff . --config pyproject.toml
+```
+
 ## Build & Publish
 
 From an installed and tested venv, do the following:
@@ -179,3 +181,4 @@ venv/bin/twine upload dist/*
 Credentials for twine should be either:
     - stored in .pypirc in the [pypi] section
     - entered at the prompt, username = **token** and password = your_api_key
+

{take-note-cli-1.1.0 → take_note_cli-1.2.0}/README.md

@@ -129,6 +129,14 @@ venv/bin/pytest
 deactivate
 ```
 
+## Linting
+
+The project uses [ruff](https://github.com/charliermarsh/ruff) for linting and optionally for formatting.
+
+```bash
+venv/bin/ruff . --config pyproject.toml
+```
+
 ## Build & Publish
 
 From an installed and tested venv, do the following:

take_note_cli-1.2.0/pyproject.toml

@@ -0,0 +1,52 @@
+[tool.poetry]
+name = "take-note-cli"
+version = "1.2.0"
+description = "Create and open notes in your favourite editor."
+license = "MIT"
+authors = [
+  "wsinned <wsinned@tutanota.com>",
+]
+readme = "README.md"
+homepage = "https://github.com/wsinned/take-note"
+repository = "https://github.com/wsinned/take-note"
+keywords = ["note", "tool", "utility", "cli"]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Utilities",
+    "License :: OSI Approved :: MIT License",
+]
+
+packages = [
+  { include = "take_note_cli", from = "src" },
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.4.3"
+dateutils = "^0.6.12"
+ruff = "^0.1.4"
+
+[tool.poetry.scripts]
+take-note = "take_note_cli.__main__:main"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "src"
+]
+
+[tool.ruff]
+src = ["src"]
+
+[tool.ruff.per-file-ignores]
+

{take-note-cli-1.1.0/src/takenote → take_note_cli-1.2.0/src/take_note_cli}/__main__.py

@@ -1,10 +1,8 @@
 import sys
-from takenote.core import notes
+from take_note_cli.core import notes
 
 
 def main():
-    print("Welcome to take-note-cli.")
-
     notes.main(sys.argv[1:])
 
 

{take-note-cli-1.1.0/src/takenote → take_note_cli-1.2.0/src/take_note_cli}/core/notes.py

@@ -1,17 +1,17 @@
-from datetime import date, timedelta
+from datetime import date
 import sys
-from takenote.utils.paths import (
+from take_note_cli.utils.paths import (
     generate_note_folder,
     generate_note_path,
     generate_template_path,
 )
-from takenote.utils.dates import (
+from take_note_cli.utils.dates import (
     get_monday,
     get_time_delta_from_options,
     format_header_date,
     get_weeks_delta,
 )
-from takenote.utils.args import process_args
+from take_note_cli.utils.args import process_args
 from subprocess import call
 
 
@@ -50,35 +50,51 @@ def get_path_for_file(week: date, folder_path):
 def create_batch_of_files(options, week, template_path):
     initial_note_path = None
     if options.batch is not None:
-        for i in range(1, options.batch):
+        for i in range(options.batch):
             batch_week = week + get_weeks_delta(i)
             note_path, file_exists = get_path_for_file(batch_week, options.notesFolder)
-            if i == 1:
+            if i == 0:
                 initial_note_path = note_path
 
             if not file_exists:
                 if options.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)
+        if not file_exists:
+            if options.verbose:
+                print(f"Creating file: {initial_note_path}")
+            create_file(initial_note_path, template_path, week)
+
     return initial_note_path
 
 
-def open_file(folder_path, editor, note_file, workspace=None):
+def open_file(folder_path, editor, note_file, verbose, workspace=None):
     args = [editor, note_file]
     if workspace:
         args.append(folder_path.joinpath(workspace))
 
+    if verbose:
+        print(f"Opening file with args: {args}")
+
     call(args)
 
 
 def main(argv):
+    template_path = None
     options, parser = process_args(argv)
+
     if options.verbose:
+        print("Welcome to take-note-cli")
         print(options)
 
     delta = calculate_week_offset(options, parser)
     week = get_monday(date.today()) + delta
-    template_path = generate_template_path(options.notesFolder, options.template)
+
+    if options.template is not None:
+        template_path = generate_template_path(options.notesFolder, options.template)
+
     note_path = create_batch_of_files(options, week, template_path)
 
-    open_file(options.notesFolder, options.editor, note_path, options.workspace)
+    open_file(options.notesFolder, options.editor, note_path, options.verbose, options.workspace)

{take-note-cli-1.1.0/src/takenote → take_note_cli-1.2.0/src/take_note_cli}/utils/args.py

@@ -1,19 +1,20 @@
 import argparse
 import pathlib
-from sys import exit
-import takenote.__version__
+import importlib.metadata
+
+__version__ = importlib.metadata.version("take-note-cli")
 
 
 def init_argparse() -> argparse.ArgumentParser:
-    help_text = """Create a notes file for the requested 
-        week."""
+    help_text = """Create a notes file for the requested
+         week."""
 
     parser = argparse.ArgumentParser(usage="%(prog)s [OPTIONS]", description=help_text)
     parser.add_argument(
         "-v",
         "--version",
         action="version",
-        version=f"{parser.prog} version {takenote.__version__}",
+        version=f"{parser.prog} version {__version__}",
     )
     parser.add_argument(
         "--verbose",
@@ -26,7 +27,8 @@ def init_argparse() -> argparse.ArgumentParser:
         default=pathlib.Path.home().joinpath("Notes"),
         type=pathlib.Path,
         help="""The root path for the notes folder. 
-        If not supplied this defaults to the Notes folder in the users home folder.""",
+        If not supplied this defaults to the Notes
+         folder in the users home folder.""",
     )
     parser.add_argument(
         "--editor",
@@ -38,7 +40,8 @@ def init_argparse() -> argparse.ArgumentParser:
         "--workspace",
         default=None,
         help="""The VSCode workspace to open along with the notes. 
-        If supplied this overrides the --editor option to 'code' for Visual Studio Code""",
+        If supplied this overrides the --editor option to 'code'
+         for Visual Studio Code""",
     )
     parser.add_argument(
         "--thisWeek",

{take-note-cli-1.1.0/src/takenote → take_note_cli-1.2.0/src/take_note_cli}/utils/dates.py

@@ -16,9 +16,8 @@ def format_file_date(the_date: date):
 
 
 def get_time_delta_from_options(options):
-    if options.thisWeek:
-        delta = timedelta(0)
-    elif options.lastWeek:
+    delta = timedelta(0)
+    if options.lastWeek:
         delta = timedelta(-WEEK)
     elif options.nextWeek:
         delta = timedelta(WEEK)
@@ -27,7 +26,7 @@ def get_time_delta_from_options(options):
 
 
 def get_weeks_delta(weeks: int):
-    if weeks >= 1:
+    if weeks >= 0:
         return timedelta(WEEK * weeks)
     else:
-        raise ValueError("Batch size must be 1 or greater.")
+        raise ValueError("Batch size must be 0 or greater.")

{take-note-cli-1.1.0/src/takenote → take_note_cli-1.2.0/src/take_note_cli}/utils/paths.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 from datetime import date
-from takenote.utils.dates import format_file_date
+from take_note_cli.utils.dates import format_file_date
 
 
 def generate_note_path(week: date):

take-note-cli-1.1.0/MANIFEST.in

@@ -1 +0,0 @@
-include LICENSE *.md

take-note-cli-1.1.0/PKG-INFO

@@ -1,181 +0,0 @@
-Metadata-Version: 2.1
-Name: take-note-cli
-Version: 1.1.0
-Summary: Create and open notes in your favourite editor.
-Home-page: https://github.com/wsinned/take-note
-Author: wsinned
-Author-email: wsinned@tutanota.com
-Project-URL: Source, https://github.com/wsinned/take-note
-Keywords: note tool utility cli
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Console
-Classifier: Natural Language :: English
-Classifier: Operating System :: OS Independent
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Utilities
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Requires-Python: <4,>=3.8
-Description-Content-Type: text/markdown; charset=UTF-8
-License-File: LICENSE
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: dateutils; extra == "test"
-Requires-Dist: black; extra == "test"
-
-# Take Note
-
-**Create and open notes in your favourite editor.**
-
-## Features
-
-- Written in Python with no runtime dependencies.
-  - Works on Python 3.8 - 3.11.
-- 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
-  - 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`
-- 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.
-
-## Future features
-
-- Support for daily notes options.
-
-## Installation
-
-### pipx
-
-The recommended way to install the published package is through [pipx](https://pypa.github.io/pipx/).
-
-```bash
-# from PyPI
-pipx install take-note-cli
-
-# direct from github
-pipx install git+https://github.com/wsinned/take-note
-```
-
-## Usage
-
-### Command Line
-
-Specify a folder using the --notesFolder option, otherwise $HOME/Notes will be used
-A week option must be supplied from --thisWeek, --lastWeek or --nextWeek
-
-```bash
-take-note --notesFolder=$HOME/MyNotes --thisWeek
-```
-
-A note will be created in the under the MyNotes/YYYY/mm folder named with the date of the Monday of this week, e.g. 2023-08-07-Weekly-log.md
-
-### Aliases
-
-Setting up aliases in you preferred shell is a great way to make accessing your notes quick and easy.
-
-```bash
-notes_folder="$HOME/SomePath/MyNotes"
-args="--notesFolder $notes_folder --workspace notes.code-workspace --template Home-weekly-log-template.md"
-
-alias thisWeek="take-note --thisWeek $args"
-alias nextWeek="take-note --nextWeek $args"
-alias lastWeek="take-note --lastWeek $args"
-```
-
-All you have to do now is type one of the following to open the desired note file.
-
-```bash
-> thisWeek
-> lastWeek
-> nextWeek
-```
-
-## Other Installation Methods
-
-### Virtual Environment
-
-```bash
-python -m venv venv 
-
-source venv/bin/activate
-
-venv/bin/pip install -r requirements.txt
-
-# install with tests as editable src
-venv/bin/pip install -e .
-
-```
-
-## Development
-
-### Nix & NixOS
-
-The supplied shell.nix definition provides support for entering a nix-shell directly in the repository with all dependencies.
-
-```zsh
-nix-shell --run zsh # ensure using zsh over default bash session
-
-# only needed once, or to recreate the virtual environment
-python -m venv venv 
-
-source venv/bin/activate
-
-# install with tests as editable src
-venv/bin/pip install -e '.[test]'
-
-# run the tests
-pytest
-
-# close the virtual environment and exit the shell when done
-deactivate
-exit
-```
-
-### Other Linux or macOS
-
-```zsh
-# only needed once, or to recreate the virtual environment
-python -m venv venv 
-
-source venv/bin/activate
-
-venv/bin/pip install -r requirements.txt -r requirements.dev.txt
-
-# install with tests as editable src
-venv/bin/pip install -e '.[test]'
-
-# run the tests
-venv/bin/pytest
-
-# close the virtual environment when done
-deactivate
-```
-
-## Build & Publish
-
-From an installed and tested venv, do the following:
-
-```bash
-# check the version:
-cat src/takenote/__version__.py
-
-# build the package
-venv/bin/pyproject-build
-
-# publish the package
-venv/bin/twine upload dist/*
-```
-
-Credentials for twine should be either:
-    - stored in .pypirc in the [pypi] section
-    - entered at the prompt, username = **token** and password = your_api_key

take-note-cli-1.1.0/pyproject.toml

@@ -1,8 +0,0 @@
-[build-system]
-requires = ["setuptools>=40.8.0", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[tool.pytest.ini_options]
-pythonpath = [
-  "src"
-]

take-note-cli-1.1.0/setup.cfg

@@ -1,54 +0,0 @@
-[metadata]
-name = take-note-cli
-version = attr: takenote.__version__
-description = Create and open notes in your favourite editor.
-long_description = file: README.md
-long_description_content_type = text/markdown; charset=UTF-8
-license_files = LICENSE
-author = wsinned
-author_email = wsinned@tutanota.com
-url = https://github.com/wsinned/take-note
-project_urls = 
-	Source = https://github.com/wsinned/take-note
-keywords = note tool utility cli
-classifiers = 
-	Development Status :: 5 - Production/Stable
-	Environment :: Console
-	Natural Language :: English
-	Operating System :: OS Independent
-	Intended Audience :: Developers
-	Topic :: Utilities
-	License :: OSI Approved :: MIT License
-	Programming Language :: Python
-	Programming Language :: Python :: 3
-	Programming Language :: Python :: 3.8
-	Programming Language :: Python :: 3.9
-	Programming Language :: Python :: 3.10
-	Programming Language :: Python :: 3.11
-	Programming Language :: Python :: 3 :: Only
-	Programming Language :: Python :: Implementation :: CPython
-
-[options.packages.find]
-where = src
-
-[options]
-package_dir = 
-	= src
-packages = find:
-include_package_data = True
-python_requires = >=3.8, <4
-
-[options.extras_require]
-test = 
-	pytest
-	dateutils
-	black
-
-[options.entry_points]
-console_scripts = 
-	take-note = takenote.__main__:main
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

take-note-cli-1.1.0/src/take_note_cli.egg-info/SOURCES.txt

@@ -1,20 +0,0 @@
-LICENSE
-MANIFEST.in
-README.md
-pyproject.toml
-setup.cfg
-src/take_note_cli.egg-info/PKG-INFO
-src/take_note_cli.egg-info/SOURCES.txt
-src/take_note_cli.egg-info/dependency_links.txt
-src/take_note_cli.egg-info/entry_points.txt
-src/take_note_cli.egg-info/requires.txt
-src/take_note_cli.egg-info/top_level.txt
-src/takenote/__init__.py
-src/takenote/__main__.py
-src/takenote/__version__.py
-src/takenote/core/__init__.py
-src/takenote/core/notes.py
-src/takenote/utils/__init__.py
-src/takenote/utils/args.py
-src/takenote/utils/dates.py
-src/takenote/utils/paths.py

take-note-cli-1.1.0/src/take_note_cli.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

take-note-cli-1.1.0/src/take_note_cli.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-take-note = takenote.__main__:main

take-note-cli-1.1.0/src/take_note_cli.egg-info/requires.txt

@@ -1,5 +0,0 @@
-
-[test]
-pytest
-dateutils
-black

take-note-cli-1.1.0/src/take_note_cli.egg-info/top_level.txt

@@ -1 +0,0 @@
-takenote

take-note-cli-1.1.0/src/takenote/__init__.py

@@ -1 +0,0 @@
-from . __version__ import __version__

take-note-cli-1.1.0/src/takenote/__version__.py

@@ -1 +0,0 @@
-__version__ = '1.1.0'