git-captains-log 0.2.0__tar.gz

git_captains_log-0.2.0/.gitignore

@@ -0,0 +1,158 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.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
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# UV
+.uv/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Project specific
+*.lock
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local

git_captains_log-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

git_captains_log-0.2.0/PKG-INFO

@@ -0,0 +1,304 @@
+Metadata-Version: 2.4
+Name: git-captains-log
+Version: 0.2.0
+Summary: Automatically aggregate git commit messages daily into markdown logs
+Author: Captain's Log Team
+License-File: LICENSE
+Requires-Python: >=3.8
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# Captain's Log
+
+Automatically aggregate your git commit messages daily into markdown logs, grouped by repository and project.
+
+---
+
+## Installation
+
+### From PyPI (Recommended for Users)
+
+Install Captain's Log from PyPI:
+
+```bash
+# Using pip
+pip install git-captains-log
+
+# Or using uv (recommended)
+uv pip install git-captains-log
+```
+
+Then run the setup command:
+
+```bash
+captains-log setup
+```
+
+This will configure Git hooks, create config files, and set everything up.
+
+See [INSTALLATION.md](INSTALLATION.md) for detailed installation instructions.
+
+### From Source (For Development)
+
+Use the automated installation script:
+
+```bash
+git clone git@github.com:koradon/captains-log.git
+cd to/cloned/repo
+chmod +x install.sh
+./install.sh
+```
+
+The `install.sh` script will:
+- Create necessary directories (`~/.captains-log` and `~/.git-hooks`)
+- Copy `update_log.py` and `commit-msg` hook to the right locations
+- Install the `btw` and `wtf` commands globally (accessible from anywhere)
+- Set proper executable permissions
+- Create a default `config.yml` file
+- Configure global git hooks path
+- Check for Python 3 and install PyYAML if needed
+
+### Pre-commit Integration (Optional)
+If you use [pre-commit](https://pre-commit.com/) in your repositories and want to keep both your global Captain's Log hooks and per-repo pre-commit hooks working together:
+
+```bash
+# After running install.sh
+chmod +x install-with-precommit.sh
+./install-with-precommit.sh
+```
+
+This will:
+- Install global hook wrappers that run pre-commit first (when `.pre-commit-config.yaml` exists)
+- Then run Captain's Log afterwards
+- Preserve your existing `core.hooksPath` configuration
+- Work seamlessly with repos that don't use pre-commit
+
+**Note:** With pre-commit integration, you don't need to run `pre-commit install` in individual repositories. The global hooks will automatically invoke pre-commit when a repo has `.pre-commit-config.yaml`.
+
+### Manual Installation
+If you prefer to install manually:
+
+1. Clone or download Captain's Log:
+
+```bash
+git clone git@github.com:koradon/captains-log.git ~/.captains-log
+cd ~/.captains-log
+```
+
+2. Install dependencies
+
+```bash
+pip install pyyaml
+```
+
+3. Configure your projects and global log repo in `~/.captains-log/config.yml`
+
+```yaml
+global_log_repo: /path/to/global/log-repo
+
+projects:
+  work-repos:
+    root: /path/to/work/repos/work-repos
+
+  private-tools:
+    root: /path/to/private/repos/tools
+    log_repo: /path/to/private-tools/log-repo
+```
+
+4. Setup Git hooks globally:
+
+```bash
+mkdir -p ~/.git-hooks
+cp ~/.captains-log/commit-msg ~/.git-hooks/
+chmod +x ~/.git-hooks/commit-msg
+git config --global core.hooksPath ~/.git-hooks
+```
+
+5. Make the Python script executable:
+
+```bash
+chmod +x ~/.captains-log/update_log.py
+```
+
+## Development Setup
+
+This project uses UV for dependency management and Just for command running. To set up the development environment:
+
+1. Install UV if you haven't already:
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+2. Install Just if you haven't already:
+```bash
+# macOS
+brew install just
+
+# Linux
+curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash
+
+# Or with cargo
+cargo install just
+```
+
+3. Install development dependencies:
+```bash
+just install-test
+```
+
+4. Run tests:
+```bash
+just test
+```
+
+5. Run tests with coverage:
+```bash
+just test-cov
+```
+
+6. Clean up generated files:
+```bash
+just clean
+```
+
+7. Run specific tests:
+```bash
+just test-file test_update_log.py
+just test-pattern "load_config"
+```
+
+## Usage
+
+### Automatic Git Commit Logging
+After setup, every git commit you make will update a daily markdown log file inside the configured log repository/directories.
+
+Logs are grouped by repository name under each project, with a date-based file (e.g., 2025-08-11.md).
+
+### Manual Log Entries with `btw` and `wtf` Commands
+
+#### `btw` Command - Log What You Did
+The `btw` (By The Way) command allows you to add manual entries to your daily logs from anywhere on your system:
+
+```bash
+btw "Reviewed the new API documentation"
+btw "Had a productive meeting about the architecture"
+btw "Fixed a bug that wasn't committed yet"
+```
+
+#### `wtf` Command - Log Issues and Problems
+The `wtf` (What The Fault) command allows you to log issues, bugs, and weird behavior in the "What Broke or Got Weird" section:
+
+```bash
+wtf "API endpoint started returning 500 errors"
+wtf "Database connection timeout after 10 minutes"
+wtf "Tests failing intermittently on CI"
+```
+
+#### How They Work:
+- **Smart Project Detection**: Uses the same project detection logic as git commits
+  - If you're in a configured project directory → logs to that project
+  - If not configured → uses the current directory name as project
+- **Different Sections**:
+  - `btw` entries appear in the "What I did" section under "## other"
+  - `wtf` entries appear in the "What Broke or Got Weird" section
+- **Same Infrastructure**: Uses your existing Captain's Log configuration and repositories
+
+#### Examples:
+
+```bash
+# From within your configured project directory
+cd ~/work/my-project
+btw "Completed code review for new feature"
+# → Adds to my-project's daily log under "What I did" → "## other"
+
+wtf "Found memory leak in background worker"
+# → Adds to my-project's daily log under "What Broke or Got Weird" → "## other"
+
+# From any directory
+cd ~/Downloads
+btw "Downloaded and reviewed the client requirements"
+# → Adds to Downloads project log under "What I did"
+```
+
+#### Installation:
+Both commands are automatically installed with the main Captain's Log installation:
+- Accessible globally from any directory
+- Installed to `~/.local/bin/btw` and `~/.local/bin/wtf` (ensure `~/.local/bin` is in your PATH)
+- No additional setup required after running `install.sh`
+
+#### Log Format:
+Your daily logs will show git commits by repository in "What I did", followed by a flat list in "What Broke or Got Weird":
+
+```markdown
+# What I did
+
+## repository-name
+- (abc1234) Actual git commit message
+
+## other-repo
+- (def5678) Another git commit
+
+## other
+- Manual entry added with btw command
+- Another manual note
+
+# Whats next
+
+
+# What Broke or Got Weird
+
+- Issue logged with wtf command
+- Another problem to investigate
+```
+
+## Testing
+To test if your installation is working correctly:
+
+### Basic Captain's Log Test
+```bash
+python3 test_hook.py
+```
+
+This will simulate a commit and show you if the log update is working properly.
+
+### Pre-commit Integration Test
+If you installed pre-commit integration, test the dispatcher:
+
+```bash
+python3 test_hook_precommit.py
+```
+
+This will test that the hook dispatcher correctly runs pre-commit (if configured) followed by Captain's Log.
+
+## Troubleshooting
+
+### Hook not running
+- Make sure you've run `install.sh` and it completed successfully
+- Check that `git config --global core.hooksPath` points to `~/.git-hooks`
+- Verify the `commit-msg` file exists in `~/.git-hooks/` and is executable
+
+### Pre-commit integration issues
+- Ensure you ran `install.sh` before `install-with-precommit.sh`
+- Check that both `commit-msg` and `commit-msg-precommit` exist in `~/.git-hooks/`
+- If pre-commit errors occur, verify you have pre-commit installed: `pip install pre-commit`
+- The integration only runs pre-commit in repos with `.pre-commit-config.yaml`
+
+### Script not found errors
+- Ensure `update_log.py` was copied to `~/.captains-log/`
+- Check that the script has execute permissions: `chmod +x ~/.captains-log/update_log.py`
+
+### Permission errors
+- Make sure both the hook and script are executable
+- Check that your user has write access to the log directories
+
+### Conflicting with existing pre-commit setup
+If you previously used `pre-commit install` in repositories:
+- You can safely leave existing `.git/hooks/` as they won't be used (global `core.hooksPath` takes precedence)
+- Or clean them up with `pre-commit uninstall` in each repo if you prefer
+
+### `btw` or `wtf` command not found
+If the `btw` or `wtf` commands are not accessible:
+- Ensure `~/.local/bin` is in your PATH: `echo $PATH | grep ~/.local/bin`
+- Add to your shell profile if missing: `echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc && source ~/.zshrc`
+- Verify the symlinks exist: `ls -la ~/.local/bin/btw ~/.local/bin/wtf`
+- Re-run the installation if needed: `./install.sh`