GJDutils 0.2.2__tar.gz

gjdutils-0.2.2/.gitignore

@@ -0,0 +1,120 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# added by GD
+.#*
+.DS_Store
+.pypirc
+

gjdutils-0.2.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Greg Detre
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gjdutils-0.2.2/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: GJDutils
+Version: 0.2.2
+Summary: A collection of useful utility functions (basics, data science/AI, web development, etc)
+Project-URL: Homepage, https://github.com/gregdetre/gjdutils
+Project-URL: Repository, https://github.com/gregdetre/gjdutils
+Author-email: Greg Detre <greg@gregdetre.com>
+License-File: LICENSE
+Keywords: ai,data science,dates,llm,strings,utilities,web development
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: ipython
+Requires-Dist: jinja2
+Requires-Dist: pydantic
+Requires-Dist: python-dotenv
+Provides-Extra: all-no-dev
+Requires-Dist: azure-cognitiveservices-speech; extra == 'all-no-dev'
+Requires-Dist: bs4; extra == 'all-no-dev'
+Requires-Dist: cachetools; extra == 'all-no-dev'
+Requires-Dist: elevenlabs; extra == 'all-no-dev'
+Requires-Dist: google-cloud-texttospeech; extra == 'all-no-dev'
+Requires-Dist: google-cloud-translate; extra == 'all-no-dev'
+Requires-Dist: humanize; extra == 'all-no-dev'
+Requires-Dist: openai; extra == 'all-no-dev'
+Requires-Dist: pendulum; extra == 'all-no-dev'
+Requires-Dist: pillow; extra == 'all-no-dev'
+Requires-Dist: playsound; extra == 'all-no-dev'
+Requires-Dist: pygame; extra == 'all-no-dev'
+Requires-Dist: python-vlc; extra == 'all-no-dev'
+Requires-Dist: speechrecognition; extra == 'all-no-dev'
+Provides-Extra: audio-lang
+Requires-Dist: azure-cognitiveservices-speech; extra == 'audio-lang'
+Requires-Dist: cachetools; extra == 'audio-lang'
+Requires-Dist: elevenlabs; extra == 'audio-lang'
+Requires-Dist: google-cloud-texttospeech; extra == 'audio-lang'
+Requires-Dist: google-cloud-translate; extra == 'audio-lang'
+Requires-Dist: playsound; extra == 'audio-lang'
+Requires-Dist: pygame; extra == 'audio-lang'
+Requires-Dist: python-vlc; extra == 'audio-lang'
+Requires-Dist: speechrecognition; extra == 'audio-lang'
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: rich; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Requires-Dist: typer; extra == 'dev'
+Requires-Dist: wheel; extra == 'dev'
+Provides-Extra: dt
+Requires-Dist: humanize; extra == 'dt'
+Requires-Dist: pendulum; extra == 'dt'
+Provides-Extra: html-web
+Requires-Dist: bs4; extra == 'html-web'
+Provides-Extra: llm
+Requires-Dist: cachetools; extra == 'llm'
+Requires-Dist: openai; extra == 'llm'
+Requires-Dist: pillow; extra == 'llm'
+Description-Content-Type: text/markdown
+
+# gjdutils
+
+A collection of useful utility functions (strings, dates, data science/AI, web development, types, etc).
+
+## Installation
+
+```bash
+pip install gjdutils
+```
+
+For optional features:
+```bash
+pip install "gjdutils[dt]"   # Date/time utilities
+pip install "gjdutils[llm]"  # AI/LLM integrations
+pip install "gjdutils[audio_lang]"  # Speech/translation, language-related
+pip install "gjdutils[html_web]"    # Web scraping
+pip install "gjdutils[dev]"  # Development tools (for tweaking `gjdutils` itself, e.g. pytest)
+
+# Install all optional dependencies at once (except `dev`, which is used for developing `gjdutils` itself)
+pip install "gjdutils[all_no_dev]"
+```
+
+### Development Setup
+
+If you're developing `gjdutils` itself:
+```bash
+# From the gjdutils root directory
+pip install -e ".[dev]"     # Install in editable mode with development dependencies
+pip install -e ".[all_no_dev]"     # Install all optional dependencies (except dev)
+```
+
+### Adding to requirements.txt
+
+To add to your `requirements.txt` in editable mode, e.g. to install all optional dependencies:
+```text
+-e "git+https://github.com/gregdetre/gjdutils.git#egg=gjdutils[all_no_dev]"
+```

gjdutils-0.2.2/README.md

@@ -0,0 +1,37 @@
+# gjdutils
+
+A collection of useful utility functions (strings, dates, data science/AI, web development, types, etc).
+
+## Installation
+
+```bash
+pip install gjdutils
+```
+
+For optional features:
+```bash
+pip install "gjdutils[dt]"   # Date/time utilities
+pip install "gjdutils[llm]"  # AI/LLM integrations
+pip install "gjdutils[audio_lang]"  # Speech/translation, language-related
+pip install "gjdutils[html_web]"    # Web scraping
+pip install "gjdutils[dev]"  # Development tools (for tweaking `gjdutils` itself, e.g. pytest)
+
+# Install all optional dependencies at once (except `dev`, which is used for developing `gjdutils` itself)
+pip install "gjdutils[all_no_dev]"
+```
+
+### Development Setup
+
+If you're developing `gjdutils` itself:
+```bash
+# From the gjdutils root directory
+pip install -e ".[dev]"     # Install in editable mode with development dependencies
+pip install -e ".[all_no_dev]"     # Install all optional dependencies (except dev)
+```
+
+### Adding to requirements.txt
+
+To add to your `requirements.txt` in editable mode, e.g. to install all optional dependencies:
+```text
+-e "git+https://github.com/gregdetre/gjdutils.git#egg=gjdutils[all_no_dev]"
+```

gjdutils-0.2.2/__VERSION__.py

@@ -0,0 +1 @@
+__version__ = "0.2.2"

gjdutils-0.2.2/docs/CODING_SHELL_SCRIPTS.md

@@ -0,0 +1,30 @@
+# Shell Script Guidelines
+
+## General Principles
+
+- Keep things simple and readable
+- Prefer Python scripts over shell scripts
+- Keep scripts minimal, concise, and focused on a single task
+- Break long main functions into sub-functions to make it easy to follow the logic
+- Prefer to show the full tracebacks & error messages, to give the user full information. Minimise try/except. 
+- Fail explicitly and loudly, e.g. , and use `set -e` in bash scripts to exit on error
+
+## Coding details
+- Scripts live in `scripts/`
+- Make scripts executable with `chmod +x`
+- Use `#!/bin/bash` or `#!/usr/bin/env python3` shebang lines
+- Use python `Typer` if command-line arguments are needed
+- Use `cmd.py` functionality, e.g. `run_cmd()`
+- If there is overlapping functionality, maybe move it into `src/shell.py` or somewhere else reusable
+- Use colors for better readability (green for success, yellow for warnings, red for errors)
+- Show progress for long-running operations
+- If it will make it easier to see what the Python is doing in a script, include a comment showing the equivalent shell commands, e.g.:
+```python
+# i.e. rm -rf dist/
+shutil.rmtree("dist", ignore_errors=True)
+```
+
+
+## Examples
+
+See `scripts/check_locally.py` for an example following most of these guidelines.

gjdutils-0.2.2/planning/250215_publishing_to_pypi.md

@@ -0,0 +1,101 @@
+# Publishing gjdutils to PyPI
+
+## Context
+- First release of gjdutils to PyPI
+- Version 0.2.0 (after rename from gdutils)
+- Package contains utility functions for strings, dates, data science/AI, web development
+
+## Prerequisites
+- Python >=3.10
+- Build tools: `pip install build twine`
+- PyPI account with 2FA configured
+- .pypirc file configured with test and prod PyPI credentials
+
+## Steps
+
+1. Build and test package locally:
+   ```bash
+   # Option 1: Automated testing script (recommended)
+   ./scripts/check_locally.sh
+   
+   # Option 2: Manual steps
+   # Clean any existing builds
+   rm -rf dist/ build/
+   
+   # Build the package
+   python -m build
+   ```
+
+2. Test PyPI Deployment:
+   ```bash
+   # Option 1: Automated testing script (recommended)
+   ./scripts/check_test_pypi.sh
+   
+   # Option 2: Manual steps
+   # Upload to test.pypi.org
+   twine upload -r testpypi dist/*
+   
+   # Create a fresh virtualenv for testing
+   python -m venv /tmp/test-gjdutils
+   source /tmp/test-gjdutils/bin/activate
+   
+   # Test installation from test.pypi.org (with dependencies from PyPI)
+   pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ gjdutils
+   
+   # Test basic functionality
+   python -c "import gjdutils; print(gjdutils.__version__)"
+   ```
+
+3. Production PyPI Deployment:
+   ```bash
+   # Upload to PyPI
+   twine upload dist/*
+   
+   # Create a fresh virtualenv for testing
+   python -m venv /tmp/prod-gjdutils
+   source /tmp/prod-gjdutils/bin/activate
+   
+   # Test installation
+   pip install gjdutils
+   
+   # Test basic functionality
+   python -c "import gjdutils; print(gjdutils.__version__)"
+   ```
+
+## Optional Features
+Package has several optional feature sets that can be installed:
+```bash
+pip install "gjdutils[dt]"        # Date/time utilities
+pip install "gjdutils[llm]"       # AI/LLM integrations
+pip install "gjdutils[audio_lang]" # Speech/translation
+pip install "gjdutils[html_web]"   # Web scraping
+pip install "gjdutils[dev]"        # Development tools
+```
+
+## Progress Tracking
+
+### Current State
+- Package renamed to gjdutils
+- Version 0.2.0 ready for release
+- All tests passing
+
+### Next Steps
+1. Build package:
+   - Clean existing builds
+   - Run build command
+   - Verify dist/ contents
+
+2. Test deployment:
+   - Upload to test.pypi.org
+   - Test installation in fresh virtualenv
+   - Verify basic functionality
+
+3. Production deployment:
+   - Upload to PyPI
+   - Test installation
+   - Verify functionality
+
+### Post-deployment
+- [ ] Update GitHub release description
+- [ ] Announce release (if needed)
+- [ ] Update documentation with PyPI installation instructions 

gjdutils-0.2.2/planning/250215_rename_gdutils_to_gjdutils.md

@@ -0,0 +1,97 @@
+# Renaming gdutils to gjdutils
+
+## Context
+- Renaming project from `gdutils` to `gjdutils` (existing `gdutils` name is taken)
+- Package contains utility functions for strings, dates, data science/AI, web development
+- Currently at version 0.1.0, moving to 0.2.0 for the rename
+
+## Files Requiring Updates
+1. Package files:
+   - pyproject.toml:
+     - Update name from "GDutils" to "GJDutils"
+     - Update GitHub URLs from gdutils to gjdutils
+   - __VERSION__.py: Update version to 0.2.0
+   - Rename directory from gdutils/ to gjdutils/
+   - Update imports in all Python files:
+     - `from gdutils import ...`
+     - `import gdutils`
+     - References like `gdutils.something()`
+
+2. Documentation/Meta:
+   - README.md: Update all references and examples
+   - .gitignore: Check for any gdutils-specific entries
+   - Any additional .md files in docs/ or root directory
+
+## Steps
+
+0. Backup (Important!)
+   ```bash
+   # Create a backup branch
+   git checkout -b backup-before-rename
+   git push origin backup-before-rename
+   # Return to main
+   git checkout main
+   ```
+
+1. Rename GitHub Repository (✓ DONE)
+   - In GitHub web UI: Settings -> rename repository from 'gdutils' to 'gjdutils'
+   - Update local git remote:
+     ```bash
+     git remote set-url origin https://github.com/gregdetre/gjdutils.git
+     ```
+   - Verify: `git remote -v`
+
+2. Local Development Changes
+   a. Create a new branch for rename changes:
+      ```bash
+      git checkout -b rename-to-gjdutils
+      ```
+   
+   b. Update configuration files:
+      - ✓ Update version to 0.2.0 in __VERSION__.py
+      - ✓ Update pyproject.toml with new name and URLs
+      - ✓ Update README.md with new package name
+      - ✓ Review other documentation files
+   
+   c. Rename the local directory:
+      ```bash
+      # From the parent directory containing gdutils/
+      mv gdutils gjdutils
+      ```
+   
+   d. Update all internal imports and references
+
+3. Testing
+   - ✓ Run existing tests to ensure they pass
+   - ✓ Test local import: `pip install -e .`
+   - ✓ Verify imports work
+
+## Progress Tracking
+
+### ✓ Completed Steps
+- ✓ Created backup branch
+- ✓ Renamed GitHub repository
+- ✓ Updated local git remote
+- ✓ Updated version to 0.2.0 in __VERSION__.py
+- ✓ Updated pyproject.toml with new name and URLs
+- ✓ Renamed source directory from src/gdutils to src/gjdutils
+- ✓ Updated imports in Python files to use gjdutils
+- ✓ Updated test files to use gjdutils
+- ✓ Fixed package __init__.py to expose version
+- ✓ Verified all tests are passing
+- ✓ Committed all changes to rename-to-gjdutils branch
+- ✓ Merged rename-to-gjdutils to main
+- ✓ Tagged v0.2.0
+
+### Files Updated
+- [x] pyproject.toml
+- [x] __VERSION__.py
+- [x] tests/test_gdutils.py (imports updated)
+- [x] All Python files in src/gjdutils/ (imports updated)
+- [x] README.md
+
+## Next Steps
+See @250215_publishing_to_pypi.md for next steps on publishing to PyPI.
+
+
+

gjdutils-0.2.2/pyproject.toml

@@ -0,0 +1,96 @@
+[project]
+# case-insensitive
+name = "GJDutils"
+# https://hatch.pypa.io/latest/config/metadata/
+dynamic = ["version"]
+authors = [
+  { name="Greg Detre", email="greg@gregdetre.com" },
+]
+description = "A collection of useful utility functions (basics, data science/AI, web development, etc)"
+readme = "README.md"
+# because I use the | syntax for type Union
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: Utilities",
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+]
+keywords = ["utilities", "strings", "dates", "data science", "web development", "llm", "ai",]
+
+dependencies = [
+    "ipython",
+    "jinja2",
+    "python-dotenv",
+    "pydantic",
+]
+
+# if you add a new optional dependency group, remember to add it to the 'all' group below
+[project.optional-dependencies]
+audio_lang = [
+    "azure-cognitiveservices-speech",
+    "cachetools",
+    "google-cloud-texttospeech",
+    "google-cloud-translate",
+    "elevenlabs",
+    # for playing mp3
+    "playsound",
+    # for playing mp3
+    "pygame",
+    # for playing mp3
+    "python-vlc",
+    "SpeechRecognition",
+]
+dev = [
+    "black",
+    "pytest",
+    "build",
+    "twine",
+    "wheel",
+    "rich",  # for console output formatting
+    "typer",  # for CLI tools
+]
+dt = [
+    "humanize",
+    "pendulum",
+]
+html_web = [
+    "bs4",
+]
+llm = [
+    "cachetools",
+    # "llm", no longer using this
+    "openai",
+    "pillow", # for images
+]
+
+all_no_dev = [
+    "gjdutils[audio_lang]",
+    "gjdutils[dt]",
+    "gjdutils[html_web]",
+    "gjdutils[llm]",
+]
+
+[project.urls]
+Homepage = "https://github.com/gregdetre/gjdutils"
+Repository = "https://github.com/gregdetre/gjdutils"
+# Issues = "https://github.com/gregdetre/gjdutils/issues"
+# Documentation
+# Changelog
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "dist/",
+    "gjdutils/obsolete/",
+    "gjdutils/todo/",
+    "tests/fixme_*.py",
+]
+
+[tool.hatch.version]
+path = "__VERSION__.py"

gjdutils-0.2.2/scripts/check_locally.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python3
+
+from rich.console import Console
+from pathlib import Path
+import shutil
+
+from gjdutils.decorators import console_print_doc
+from gjdutils.shell import temp_venv
+from gjdutils.cmd import run_cmd
+from gjdutils.pypi_build import verify_installation, check_install_optional_features
+
+console = Console()
+
+
+@console_print_doc(color="yellow")
+def clean_build_dirs():
+    """Cleaning existing builds..."""
+    # Command: rm -rf dist/ build/
+    shutil.rmtree("dist", ignore_errors=True)
+    shutil.rmtree("build", ignore_errors=True)
+
+
+def build_package():
+    return run_cmd(
+        f"python -m build",
+        before_msg="Building package...",
+        fatal_msg="Failed to build package",
+    )
+
+
+def install_and_test_package(python_path: Path, wheel_file: Path):
+    """Installing and testing package..."""
+    # Command: pip install dist/*.whl
+    run_cmd(
+        f"{python_path} -m pip install {wheel_file}",
+        before_msg="Installing package wheel file from local build...",
+        fatal_msg="Failed to install package",
+    )
+
+    # Command: pip install ".[dev]"
+    run_cmd(
+        f"{python_path} -m pip install '.[dev]'",
+        before_msg="Installing dev dependencies...",
+        fatal_msg="Failed to install dev dependencies",
+    )
+
+
+def run_test_suite(python_path: Path):
+    return run_cmd(
+        f"{python_path} -m pytest",
+        before_msg="Running test suite...",
+        fatal_msg="Test suite failed",
+    )
+
+
+def main():
+    console.rule("[yellow]Starting local package testing")
+
+    clean_build_dirs()
+    build_package()
+
+    venv_path = Path("/tmp/test-gjdutils")
+    with temp_venv(venv_path) as python_path:
+        wheel_file = next(Path("dist").glob("*.whl"))
+        install_and_test_package(python_path, wheel_file)
+        verify_installation(python_path)
+        run_test_suite(python_path)
+        check_install_optional_features(python_path)
+
+    console.print("\nLocal testing completed successfully!", style="green")
+
+
+if __name__ == "__main__":
+    main()