desertislandutils 0.4.2__tar.gz → 0.4.3__tar.gz

desertislandutils-0.4.3/PKG-INFO

@@ -0,0 +1,179 @@
+Metadata-Version: 2.4
+Name: desertislandutils
+Version: 0.4.3
+Summary: A collection of personal convenience utilities
+Project-URL: Homepage, https://github.com/mahiki/desertislandutils
+Project-URL: Repository, https://github.com/mahiki/desertislandutils
+Project-URL: Issues, https://github.com/mahiki/desertislandutils/issues
+Author-email: mahiki <mahiki@users.noreply.github.com>
+License: MIT
+Requires-Python: >=3.11
+Requires-Dist: argparse>=1.4.0
+Requires-Dist: gitpython>=3.1.27
+Requires-Dist: pendulum>=3.0.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: ptpython>=3.0.23; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest>=7.2.2; extra == 'test'
+Description-Content-Type: text/markdown
+
+# desertislandutils
+
+A collection of personal convenience utilities for managing parallel directory structures and ISO week numbers. Written in Python because it's far better than shell scripting!
+
+## Installation
+
+Install globally using `uv`:
+
+```sh
+uv tool install desertislandutils
+```
+
+Update to the latest version:
+
+```sh
+uv tool upgrade desertislandutils
+```
+
+## The Utils
+
+### toobigdatadoc (`too`)
+
+Manage parallel directory structures for separating text files from large binary files and datasets. Creates symlinked folders under `HOME/{toobig|toodata|toodoc}`:
+
+- `toobig` - Large files excluded from backups
+- `toodata` - Small-ish data files  
+- `toodoc` - Binary files like PDFs and images
+
+```
+$HOME
+    |-- toobig
+        |-- # replicated folder paths with large files here, assume not to be backed up
+    |-- toodata
+        |-- # small-ish data files in support of the parallel root
+    |-- toodoc
+        |-- # usually pdfs or image files
+```
+
+**Usage:**
+
+```sh
+too --help
+
+usage: too [-h] {big,data,doc}
+
+Create symlinked parallel folders under HOME/{toobig|toodata|toodoc}, to
+contain data/binary files outside of git repo or away from source/text files.
+
+positional arguments:
+  {big,data,doc}  large files to exclude from backup, smallish datasets,
+                  binary files like pdf
+
+options:
+  -h, --help      show this help message and exit
+```
+
+### weeknumber (`wn`)
+
+Get ISO year week numbers in YYYY-WDD format. Default weekend day is Saturday.
+
+**Usage:**
+
+```sh
+wn --help
+
+ Usage: wn [OPTIONS] [DATE]                                                     
+                                                                                
+ ISO year week number of a date as YYYY-"W"WW. Default weekend day is Saturday.
+                                                                                
+ Example:                                                                       
+                                                                                
+ $> wn 'Jul 22 2020' --last                                                     
+                                                                                
+ 2020-W29                                                                       
+                                                                                
+╭─ Arguments ────────────────────────────────────────────────────────────────╮
+│   date      [DATE]  A text expression of date, ex: 'November 27', or      │
+│                     2112-07-29. Default is today's in current TZ.          │
+│                     [default: (dynamic)]                                   │
+╰────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ──────────────────────────────────────────────────────────────────╮
+│ --sunday              Week end is Saturday by default, this flag sets     │
+│                       Sunday weekend day (ISO standard).                   │
+│ --last                Give week number of most recently completed week    │
+│                       (overrides DATE argument).                           │
+│ --verbose      -v     Full parsed date details for verification.          │
+│ --install-completion  Install completion for the current shell.           │
+│ --show-completion     Show completion for the current shell, to copy it   │
+│                       or customize the installation.                       │
+│ --help                Show this message and exit.                          │
+╰────────────────────────────────────────────────────────────────────────────╯
+```
+
+**Examples:**
+
+```sh
+# Get current week number
+wn
+
+# Get week number for a specific date
+wn 'Jul 22'
+
+# Get last completed week number
+wn --last
+
+# Parse a specific date with details
+wn 'November 27 2024' --verbose
+```
+
+---
+
+## Development
+
+Built with modern Python tooling:
+
+- **Build system:** `uv`
+- **Deploy:** PyPI via GitHub Actions CI/CD
+- **Package manager:** `uv`
+
+### Setup
+
+```sh
+# Clone the repository
+git clone https://github.com/mahiki/desertislandutils.git
+cd desertislandutils
+
+# Install dependencies (including dev extras)
+uv sync --all-extras
+```
+
+### Testing
+
+```sh
+# Run tests
+just test
+
+# Or directly with uv
+uv run --extra test pytest --disable-warnings --verbose
+```
+
+### Local Development
+
+```sh
+# Run commands directly from source
+uv run wn --help
+uv run too --help
+```
+
+### Project Tasks
+
+See the `justfile` for available commands:
+
+```sh
+just --list
+```
+
+## License
+
+MIT

desertislandutils-0.4.3/README.md

@@ -0,0 +1,159 @@
+# desertislandutils
+
+A collection of personal convenience utilities for managing parallel directory structures and ISO week numbers. Written in Python because it's far better than shell scripting!
+
+## Installation
+
+Install globally using `uv`:
+
+```sh
+uv tool install desertislandutils
+```
+
+Update to the latest version:
+
+```sh
+uv tool upgrade desertislandutils
+```
+
+## The Utils
+
+### toobigdatadoc (`too`)
+
+Manage parallel directory structures for separating text files from large binary files and datasets. Creates symlinked folders under `HOME/{toobig|toodata|toodoc}`:
+
+- `toobig` - Large files excluded from backups
+- `toodata` - Small-ish data files  
+- `toodoc` - Binary files like PDFs and images
+
+```
+$HOME
+    |-- toobig
+        |-- # replicated folder paths with large files here, assume not to be backed up
+    |-- toodata
+        |-- # small-ish data files in support of the parallel root
+    |-- toodoc
+        |-- # usually pdfs or image files
+```
+
+**Usage:**
+
+```sh
+too --help
+
+usage: too [-h] {big,data,doc}
+
+Create symlinked parallel folders under HOME/{toobig|toodata|toodoc}, to
+contain data/binary files outside of git repo or away from source/text files.
+
+positional arguments:
+  {big,data,doc}  large files to exclude from backup, smallish datasets,
+                  binary files like pdf
+
+options:
+  -h, --help      show this help message and exit
+```
+
+### weeknumber (`wn`)
+
+Get ISO year week numbers in YYYY-WDD format. Default weekend day is Saturday.
+
+**Usage:**
+
+```sh
+wn --help
+
+ Usage: wn [OPTIONS] [DATE]                                                     
+                                                                                
+ ISO year week number of a date as YYYY-"W"WW. Default weekend day is Saturday.
+                                                                                
+ Example:                                                                       
+                                                                                
+ $> wn 'Jul 22 2020' --last                                                     
+                                                                                
+ 2020-W29                                                                       
+                                                                                
+╭─ Arguments ────────────────────────────────────────────────────────────────╮
+│   date      [DATE]  A text expression of date, ex: 'November 27', or      │
+│                     2112-07-29. Default is today's in current TZ.          │
+│                     [default: (dynamic)]                                   │
+╰────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ──────────────────────────────────────────────────────────────────╮
+│ --sunday              Week end is Saturday by default, this flag sets     │
+│                       Sunday weekend day (ISO standard).                   │
+│ --last                Give week number of most recently completed week    │
+│                       (overrides DATE argument).                           │
+│ --verbose      -v     Full parsed date details for verification.          │
+│ --install-completion  Install completion for the current shell.           │
+│ --show-completion     Show completion for the current shell, to copy it   │
+│                       or customize the installation.                       │
+│ --help                Show this message and exit.                          │
+╰────────────────────────────────────────────────────────────────────────────╯
+```
+
+**Examples:**
+
+```sh
+# Get current week number
+wn
+
+# Get week number for a specific date
+wn 'Jul 22'
+
+# Get last completed week number
+wn --last
+
+# Parse a specific date with details
+wn 'November 27 2024' --verbose
+```
+
+---
+
+## Development
+
+Built with modern Python tooling:
+
+- **Build system:** `uv`
+- **Deploy:** PyPI via GitHub Actions CI/CD
+- **Package manager:** `uv`
+
+### Setup
+
+```sh
+# Clone the repository
+git clone https://github.com/mahiki/desertislandutils.git
+cd desertislandutils
+
+# Install dependencies (including dev extras)
+uv sync --all-extras
+```
+
+### Testing
+
+```sh
+# Run tests
+just test
+
+# Or directly with uv
+uv run --extra test pytest --disable-warnings --verbose
+```
+
+### Local Development
+
+```sh
+# Run commands directly from source
+uv run wn --help
+uv run too --help
+```
+
+### Project Tasks
+
+See the `justfile` for available commands:
+
+```sh
+just --list
+```
+
+## License
+
+MIT

{desertislandutils-0.4.2 → desertislandutils-0.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "desertislandutils"
-version = "0.4.2"
+version = "0.4.3"
 description = "A collection of personal convenience utilities"
 authors = [{name = "mahiki", email = "mahiki@users.noreply.github.com"}]
 license = {text = "MIT"}
@@ -13,6 +13,11 @@ dependencies = [
     "pendulum>=3.0.0",
 ]
 
+[project.urls]
+Homepage = "https://github.com/mahiki/desertislandutils"
+Repository = "https://github.com/mahiki/desertislandutils"
+Issues = "https://github.com/mahiki/desertislandutils/issues"
+
 [project.optional-dependencies]
 dev = [
     "ptpython>=3.0.23",

desertislandutils-0.4.2/PKG-INFO

@@ -1,96 +0,0 @@
-Metadata-Version: 2.4
-Name: desertislandutils
-Version: 0.4.2
-Summary: A collection of personal convenience utilities
-Author-email: mahiki <mahiki@users.noreply.github.com>
-License: MIT
-Requires-Python: >=3.11
-Requires-Dist: argparse>=1.4.0
-Requires-Dist: gitpython>=3.1.27
-Requires-Dist: pendulum>=3.0.0
-Requires-Dist: typer>=0.12.0
-Provides-Extra: dev
-Requires-Dist: ptpython>=3.0.23; extra == 'dev'
-Provides-Extra: test
-Requires-Dist: pytest>=7.2.2; extra == 'test'
-Description-Content-Type: text/markdown
-
-# desertislandutils
-Refactoring my convenience utility bash scripts into python for learning and profit. Deployed for MacOS via homebrew, its really far better than shell scripting, yuck!
-
-## INSTALL
-    brew install mahiki/tap/desertislandutils
-
-## THE UTILS
-### toobigdatadoc
-I like to keep text files in one directory system, with supporting data files and binary documents in parallel directories from the home folder: `toobig`, `toodata`, `toodoc`. For example, its easy to exclude the whole `toobig` directory structure from backups, since there is nothing but huge files here.
-
-    $HOME
-        |-- toobig
-            |-- # replicated folder paths with large files here, assume not to be backed up
-        |-- toodata
-            |-- # small-ish data files in support of the parallel root
-        |-- toodoc
-            |-- # usually pdfs or image files
-
-```sh
-$> too --help
-usage: too [-h] {big,data,doc}
-
-Create symlinked parallel folders to contain data/binary files outside of git repo or away from source/text files.
-
-positional arguments:
-  {big,data,doc}  large files to exclude from backup, smallish datasets, binary files like pdf
-
-optional arguments:
-  -h, --help      show this help message and exit
-Kehena segovia: ~
-```
-
-### weeknumber
-```sh
-wn --help
-
- Usage: wn [OPTIONS] [DATE]
-
- ISO year week number of a date as YYYY-WDD. Default weekend day is Sat.
- Example:
- $> wn 'Jul 22'
- 2023-W29
-
-╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────╮
-│   date      [DATE]  A text expression of date, ex: 'November 27', or 2112-07-29 [default: (dynamic)]          │
-╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
-╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────╮
-│ --sunday                     Weekend is Saturday by default, this flag sets Sunday weekend day.               │
-│ --last                       Give week number of most recently completed week (overrides DATE argument).      │
-│ --verbose       --no-verbose [default: no-verbose]                                                            │
-│ --install-completion         Install completion for the current shell.                                        │
-│ --show-completion            Show completion for the current shell, to copy it or customize the installation. │
-│ --help                       Show this message and exit.                                                      │
-╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
-```
-
-----------
-## DEVELOPMENT
->Trying to automate the merge tag homebrew tap repo upgrade thing. Its not going great.
-
-* build: poetry
-* deploy: poetry -> pypi -> homebrew
-* github CI actions
-
-### JUSTFILE
->Best documentation is in the Just taskrunner `justfile`.
-
-```sh
-just info
-
-just wn --help
-
-# also direct into poetry environment
-poetry shell
-(desertislandutils)> wn --help
-```
-
-### Testing
-    just test

desertislandutils-0.4.2/README.md

@@ -1,79 +0,0 @@
-# desertislandutils
-Refactoring my convenience utility bash scripts into python for learning and profit. Deployed for MacOS via homebrew, its really far better than shell scripting, yuck!
-
-## INSTALL
-    brew install mahiki/tap/desertislandutils
-
-## THE UTILS
-### toobigdatadoc
-I like to keep text files in one directory system, with supporting data files and binary documents in parallel directories from the home folder: `toobig`, `toodata`, `toodoc`. For example, its easy to exclude the whole `toobig` directory structure from backups, since there is nothing but huge files here.
-
-    $HOME
-        |-- toobig
-            |-- # replicated folder paths with large files here, assume not to be backed up
-        |-- toodata
-            |-- # small-ish data files in support of the parallel root
-        |-- toodoc
-            |-- # usually pdfs or image files
-
-```sh
-$> too --help
-usage: too [-h] {big,data,doc}
-
-Create symlinked parallel folders to contain data/binary files outside of git repo or away from source/text files.
-
-positional arguments:
-  {big,data,doc}  large files to exclude from backup, smallish datasets, binary files like pdf
-
-optional arguments:
-  -h, --help      show this help message and exit
-Kehena segovia: ~
-```
-
-### weeknumber
-```sh
-wn --help
-
- Usage: wn [OPTIONS] [DATE]
-
- ISO year week number of a date as YYYY-WDD. Default weekend day is Sat.
- Example:
- $> wn 'Jul 22'
- 2023-W29
-
-╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────╮
-│   date      [DATE]  A text expression of date, ex: 'November 27', or 2112-07-29 [default: (dynamic)]          │
-╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
-╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────╮
-│ --sunday                     Weekend is Saturday by default, this flag sets Sunday weekend day.               │
-│ --last                       Give week number of most recently completed week (overrides DATE argument).      │
-│ --verbose       --no-verbose [default: no-verbose]                                                            │
-│ --install-completion         Install completion for the current shell.                                        │
-│ --show-completion            Show completion for the current shell, to copy it or customize the installation. │
-│ --help                       Show this message and exit.                                                      │
-╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
-```
-
-----------
-## DEVELOPMENT
->Trying to automate the merge tag homebrew tap repo upgrade thing. Its not going great.
-
-* build: poetry
-* deploy: poetry -> pypi -> homebrew
-* github CI actions
-
-### JUSTFILE
->Best documentation is in the Just taskrunner `justfile`.
-
-```sh
-just info
-
-just wn --help
-
-# also direct into poetry environment
-poetry shell
-(desertislandutils)> wn --help
-```
-
-### Testing
-    just test