llmsbrieftxt 1.3.1__tar.gz

llmsbrieftxt-1.3.1/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,104 @@
+name: Bug Report
+description: Report a bug or unexpected behavior
+title: "[Bug]: "
+labels: ["bug", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug! Please fill out the information below to help us resolve the issue.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Bug Description
+      description: A clear and concise description of what the bug is.
+      placeholder: When I run llmtxt with..., I expect..., but instead...
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to reproduce the behavior
+      placeholder: |
+        1. Run command: llmtxt https://example.com
+        2. Observe error...
+        3. ...
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What you expected to happen
+      placeholder: I expected the tool to...
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened
+      placeholder: Instead, the tool...
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Error Logs / Output
+      description: Please paste any relevant error messages or output
+      render: shell
+      placeholder: |
+        Paste error output here...
+
+  - type: input
+    id: version
+    attributes:
+      label: llmsbrieftxt Version
+      description: Run `pip show llmsbrieftxt` to get the version
+      placeholder: "1.0.0"
+    validations:
+      required: true
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python Version
+      description: Run `python --version` to get your Python version
+      placeholder: "3.11.0"
+    validations:
+      required: true
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating System
+      description: Which OS are you using?
+      placeholder: "macOS 14.0, Ubuntu 22.04, Windows 11, etc."
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Any other context, screenshots, or information that might be helpful
+      placeholder: Add any other context about the problem here
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Pre-submission Checklist
+      description: Please confirm the following before submitting
+      options:
+        - label: I have searched existing issues to ensure this is not a duplicate
+          required: true
+        - label: I have tested with the latest version of llmsbrieftxt
+          required: true
+        - label: I have included complete error messages and logs
+          required: true

llmsbrieftxt-1.3.1/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 GitHub Discussions
+    url: https://github.com/stevennevins/llmsbrief/discussions
+    about: Ask questions and discuss ideas with the community
+  - name: 📚 Documentation
+    url: https://github.com/stevennevins/llmsbrief#readme
+    about: Read the documentation and guides

llmsbrieftxt-1.3.1/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,87 @@
+name: Feature Request
+description: Suggest a new feature or enhancement
+title: "[Feature]: "
+labels: ["enhancement", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for suggesting a new feature! Please provide as much detail as possible to help us understand your request.
+
+        **Note:** llmsbrieftxt follows the Unix philosophy of doing one thing well. Features should align with the core mission: generating llms-brief.txt files from documentation websites.
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem or Use Case
+      description: What problem does this feature solve? What use case does it enable?
+      placeholder: |
+        I want to be able to... because...
+        Currently, I can't... which means...
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Solution
+      description: How would you like this feature to work?
+      placeholder: |
+        Add a new option `--example` that would...
+        The behavior should be...
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives Considered
+      description: What alternatives have you considered? Are there workarounds?
+      placeholder: |
+        I considered using X, but...
+        As a workaround, I currently...
+
+  - type: textarea
+    id: examples
+    attributes:
+      label: Usage Examples
+      description: Provide examples of how this feature would be used
+      render: bash
+      placeholder: |
+        # Example usage
+        llmtxt https://example.com --new-option value
+
+  - type: dropdown
+    id: alignment
+    attributes:
+      label: Alignment with Project Philosophy
+      description: Does this feature align with the Unix philosophy of doing one thing well?
+      options:
+        - "Yes - Directly enhances llms-brief.txt generation"
+        - "Maybe - Could be considered a core feature"
+        - "No - This is a complementary tool/feature"
+    validations:
+      required: true
+
+  - type: textarea
+    id: impact
+    attributes:
+      label: Impact
+      description: |
+        Who benefits from this feature? How critical is it?
+      placeholder: |
+        This would benefit users who...
+        Impact: High/Medium/Low
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Pre-submission Checklist
+      description: Please confirm the following before submitting
+      options:
+        - label: I have searched existing issues and discussions to ensure this hasn't been requested
+          required: true
+        - label: I have considered whether this aligns with the project's Unix philosophy
+          required: true
+        - label: I have provided a clear use case and motivation
+          required: true

llmsbrieftxt-1.3.1/.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,63 @@
+name: Question or Support
+description: Ask a question or get help using llmsbrieftxt
+title: "[Question]: "
+labels: ["question", "support"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Have a question about using llmsbrieftxt? We're here to help!
+
+        **Tip:** For general discussions and community help, consider using [GitHub Discussions](https://github.com/stevennevins/llmsbrief/discussions) instead.
+
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: What would you like to know?
+      placeholder: How do I...? What is the best way to...?
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Context
+      description: Provide any relevant context about what you're trying to accomplish
+      placeholder: |
+        I'm trying to...
+        My use case is...
+
+  - type: textarea
+    id: attempted
+    attributes:
+      label: What Have You Tried?
+      description: What have you already attempted? Include commands, configurations, etc.
+      render: bash
+      placeholder: |
+        I tried running:
+        llmtxt https://example.com --option value
+
+        But I'm not sure if...
+
+  - type: textarea
+    id: documentation
+    attributes:
+      label: Documentation Consulted
+      description: Which documentation have you already checked?
+      placeholder: |
+        - [ ] README.md
+        - [ ] CLAUDE.md
+        - [ ] CONTRIBUTING.md
+        - [ ] Searched existing issues
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Pre-submission Checklist
+      description: Please confirm the following
+      options:
+        - label: I have checked the README and documentation
+          required: true
+        - label: I have searched existing issues and discussions
+          required: true

llmsbrieftxt-1.3.1/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,44 @@
+## Description
+<!-- Describe your changes in detail -->
+
+## Type of Change
+<!-- Check the one that applies -->
+- [ ] `feat`: New feature (minor version bump)
+- [ ] `fix`: Bug fix (patch version bump)
+- [ ] `docs`: Documentation only changes
+- [ ] `style`: Code style changes (formatting, etc.)
+- [ ] `refactor`: Code refactoring (no functional changes)
+- [ ] `perf`: Performance improvements
+- [ ] `test`: Adding or updating tests
+- [ ] `build`: Changes to build system or dependencies
+- [ ] `ci`: Changes to CI/CD configuration
+- [ ] `chore`: Other changes that don't modify src or test files
+
+## Breaking Changes
+<!-- If this introduces breaking changes, check the box and describe them -->
+- [ ] This is a breaking change (major version bump)
+
+## Checklist
+- [ ] PR title follows [Conventional Commits](https://www.conventionalcommits.org/) format (e.g., `feat: add new feature` or `fix: resolve bug`)
+- [ ] Tests pass locally (`uv run pytest`)
+- [ ] Code is formatted (`uv run black . && uv run isort .`)
+- [ ] Type checking passes (`uv run mypy llmsbrieftxt/`)
+
+---
+
+### PR Title Format
+Your PR title **must** follow this format:
+```
+<type>: <description>
+```
+
+**Examples:**
+- `feat: add support for custom output formats`
+- `fix: resolve crash when crawling large sites`
+- `docs: update installation instructions`
+- `feat!: redesign API (breaking change)`
+
+**Note:** The PR title determines the version bump:
+- `feat:` → minor version bump (1.0.0 → 1.1.0)
+- `fix:` → patch version bump (1.0.0 → 1.0.1)
+- `feat!:` or `BREAKING CHANGE:` → major version bump (1.0.0 → 2.0.0)

llmsbrieftxt-1.3.1/.github/pull_request_template.md

@@ -0,0 +1,63 @@
+## Summary
+
+<!-- Provide a brief description of the changes in this PR -->
+
+## Motivation
+
+<!-- Why is this change needed? What problem does it solve? -->
+
+## Type of Change
+
+<!-- Mark the relevant option with an 'x' -->
+
+- [ ] `feat:` New feature (minor version bump)
+- [ ] `fix:` Bug fix (patch version bump)
+- [ ] `docs:` Documentation only changes
+- [ ] `style:` Code style changes (formatting, whitespace, etc.)
+- [ ] `refactor:` Code refactoring (no functional changes)
+- [ ] `perf:` Performance improvements
+- [ ] `test:` Adding or updating tests
+- [ ] `chore:` Maintenance tasks, dependency updates
+- [ ] `ci:` CI/CD pipeline changes
+- [ ] `BREAKING CHANGE` (requires `!` in PR title or `BREAKING CHANGE:` in description)
+
+## Testing
+
+<!-- Describe how you tested these changes -->
+
+- [ ] Unit tests added/updated
+- [ ] Integration tests added/updated (if applicable)
+- [ ] All existing tests pass (`uv run pytest`)
+- [ ] Manual testing performed (describe below)
+
+**Manual Testing:**
+<!-- Describe any manual testing you performed -->
+
+## Code Quality Checklist
+
+<!-- Confirm all checks pass before requesting review -->
+
+- [ ] Code linted successfully (`uv run ruff check llmsbrieftxt/ tests/`)
+- [ ] Code formatted successfully (`uv run ruff format llmsbrieftxt/ tests/`)
+- [ ] Type checking passes (`uv run mypy llmsbrieftxt/`)
+- [ ] All tests pass (`uv run pytest`)
+- [ ] PR title follows [Conventional Commits](https://www.conventionalcommits.org/) format
+- [ ] Commit messages follow Conventional Commits format
+
+## Additional Context
+
+<!-- Add any other context, screenshots, or information about the PR here -->
+
+## Related Issues
+
+<!-- Link any related issues using GitHub keywords: Fixes #123, Closes #456, Relates to #789 -->
+
+---
+
+<!--
+PR Title Format:
+- feat: add support for custom user agents
+- fix: resolve URL normalization edge case
+- docs: improve installation instructions
+- feat!: change default output location (breaking change)
+-->

llmsbrieftxt-1.3.1/.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "latest"
+
+    - name: Install dependencies
+      run: |
+        uv python install ${{ matrix.python-version }}
+        uv sync --group dev
+
+    - name: Run unit tests
+      run: |
+        uv run pytest tests/unit -v --tb=short
+
+    - name: Run linting and formatting checks
+      run: |
+        uv run ruff check llmsbrieftxt/ tests/
+        uv run ruff format --check llmsbrieftxt/ tests/
+
+    - name: Type checking
+      run: |
+        uv run pyright llmsbrieftxt/

llmsbrieftxt-1.3.1/.github/workflows/pr-title-check.yml

@@ -0,0 +1,48 @@
+name: PR Title Check
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+      - reopened
+
+permissions:
+  pull-requests: read
+
+jobs:
+  validate-pr-title:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          # Configure allowed types (will affect version bumping)
+          types: |
+            feat
+            fix
+            docs
+            style
+            refactor
+            perf
+            test
+            build
+            ci
+            chore
+            revert
+          # Require scope to be present (e.g., "feat(api): ...")
+          requireScope: false
+          # Subjects must not be empty
+          subjectPattern: ^(?![A-Z]).+$
+          subjectPatternError: |
+            The subject "{subject}" found in the pull request title "{title}"
+            didn't match the configured pattern. Please ensure that the subject
+            doesn't start with an uppercase character.
+          # GitHub releases will be created for these types when using bump script
+          # feat -> minor bump
+          # fix -> patch bump
+          # feat! or BREAKING CHANGE -> major bump
+          wip: false
+          validateSingleCommit: false

llmsbrieftxt-1.3.1/.github/workflows/release.yml

@@ -0,0 +1,111 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  create-release-tag:
+    # Only run on main branch pushes (not tags)
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    outputs:
+      tag: ${{ steps.bump.outputs.tag }}
+      bumped: ${{ steps.bump.outputs.bumped }}
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Fetch all history and tags
+
+    - name: Configure Git
+      run: |
+        git config user.name "github-actions[bot]"
+        git config user.email "github-actions[bot]@users.noreply.github.com"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "latest"
+
+    - name: Analyze commits and create version tag
+      id: bump
+      run: |
+        uv python install 3.11
+        uv run python scripts/bump_version.py | tee bump_output.txt
+
+        # Parse output
+        VERSION=$(grep "^version=" bump_output.txt | cut -d'=' -f2)
+        BUMPED=$(grep "^bumped=" bump_output.txt | cut -d'=' -f2)
+        TAG=$(grep "^tag=" bump_output.txt | cut -d'=' -f2)
+
+        echo "version=$VERSION"
+        echo "bumped=$BUMPED"
+        echo "tag=$TAG"
+
+        # Set outputs for next job
+        echo "tag=$TAG" >> $GITHUB_OUTPUT
+        echo "bumped=$BUMPED" >> $GITHUB_OUTPUT
+
+        # Only push tag if a bump occurred
+        if [ "$BUMPED" = "true" ]; then
+          echo "Pushing tag $TAG"
+          git push origin $TAG
+        else
+          echo "No version bump needed, skipping tag creation"
+        fi
+
+  build-and-publish:
+    runs-on: ubuntu-latest
+    needs: [create-release-tag]
+    # Only run if automated tag was created
+    if: needs.create-release-tag.outputs.bumped == 'true'
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Inject static version into pyproject.toml
+      run: |
+        # Extract version from tag (strip 'v' prefix)
+        VERSION="${{ needs.create-release-tag.outputs.tag }}"
+        VERSION="${VERSION#v}"
+        echo "Injecting static version: $VERSION"
+
+        # Replace dynamic version with static version
+        sed -i 's/^dynamic = \["version"\]/version = "'$VERSION'"/' pyproject.toml
+
+        # Remove hatch-vcs configuration section
+        sed -i '/^\[tool\.hatch\.version\]/,/^$/d' pyproject.toml
+
+        # Verify the changes
+        echo "Modified pyproject.toml [project] section:"
+        grep -A 3 '^\[project\]' pyproject.toml | head -5
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "latest"
+
+    - name: Build package
+      run: |
+        uv python install 3.11
+        uv build
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        skip-existing: true
+
+    - name: Create GitHub Release
+      uses: softprops/action-gh-release@v2
+      with:
+        tag_name: ${{ needs.create-release-tag.outputs.tag }}
+        files: dist/*
+        generate_release_notes: true

llmsbrieftxt-1.3.1/.gitignore

@@ -0,0 +1,14 @@
+.env
+**/__pycache__/
+.pytest_cache/
+.venv/
+.claude/
+.ruff_cache/
+.llmsbrieftxt_cache/
+.summaries/
+.mypy_cache/
+
+# Build artifacts
+dist/
+build/
+*.egg-info/