datefind 0.1.0__tar.gz

datefind-0.1.0/.cursor/rules/all_python_rules.mdc

@@ -0,0 +1,10 @@
+---
+description: Include all python rules
+globs: **/*.py
+alwaysApply: false
+---
+[inline-comment-usage.mdc](mdc:.cursor/rules/inline-comment-usage.mdc)
+[pytest-test-rules.mdc](mdc:.cursor/rules/pytest-test-rules.mdc)
+[python-docstring-rules.mdc](mdc:.cursor/rules/python-docstring-rules.mdc)
+[python-naming-conventions.mdc](mdc:.cursor/rules/python-naming-conventions.mdc)
+[use-pathlib.mdc](mdc:.cursor/rules/use-pathlib.mdc)

datefind-0.1.0/.cursor/rules/cursor-rule-location.mdc

@@ -0,0 +1,13 @@
+---
+description: Cursor Rules Location, creating cursor rules files
+globs: *.mdc
+alwaysApply: false
+---
+# Cursor Rules Location
+
+Always follow these rules when creating cursor rule files
+
+1. Only use `.mdc` for the file extension
+2. Always place rule files in `PROJECT_ROOT/.cursor/rules/`
+3. Use kebab case for filenames
+4. Make filenames descriptive of the rule's purpose

datefind-0.1.0/.cursor/rules/inline-comment-usage.mdc

@@ -0,0 +1,44 @@
+---
+description: writing inline comments in code, editing inline comments in code
+globs: **/*.py
+alwaysApply: false
+---
+# Writing inline comments
+
+Always follow these standards for writing inline comments within the codebase to enhance understanding and avoid clutter.
+
+1. Use comments sparingly, and when you do write comments, make them meaningful.
+2. Don't comment on obvious things. Excessive or unclear comments can clutter the codebase and become outdated.
+3. Only use comments to convey the "why" behind specific actions or to explain unusual behavior and potential pitfalls.
+4. In python use `#` for single-line comments and `"""` for multi-line comments.
+5. Never change or remove 'noqa' or 'type: ignore' comments
+6. Never describe the code. Assume the person reading the code knows Python (though not what you're trying to do) better than you do.
+
+## Examples of good inline comment usage:
+
+These comments are good because they explain WHY certain steps are made
+
+```python
+# Process items in reverse to ensure the most recent data is prioritized over older data to match user expectations
+for items in reversed(items):
+    item.price = 20 # Set the price to 20 to match the competitor's pricing strategy
+...
+
+This comment is good because it clarifies complex logic
+
+```python
+# This loop uses the Fisher-Yates algorithm to shuffle the array
+
+for i in range(len(arr) - 1, 0, -1):
+    j = random.randint(0, i)
+    arr[i], arr[j] = arr[j], arr[i]
+```
+
+```python
+# We use a weighted dictionary search to find out where i is in
+# the array.  We extrapolate position based on the largest num
+# in the array and the array size and then do binary search to
+# get the exact number.
+
+if i & (i-1) == 0:  # True if i is 0 or a power of 2.
+```

datefind-0.1.0/.cursor/rules/pytest-test-rules.mdc

@@ -0,0 +1,36 @@
+---
+description: Writing pytest tests, editing pytest tests
+globs: tests/**/*.py
+alwaysApply: false
+---
+# Standards for writing pytest tests
+
+Always follow these rules and standards for writing Python tests.
+
+1. Write single sentence docstrings in imperative voice
+2. Docstrings should always start with the word "Verify"
+3. Structure test body with given/when/then comments
+4. Use pytest-mock plugin. Do not use unittest.
+5. Include unit and integration tests.
+
+## Examples of good tests
+
+```python
+def test_backup_file_creates_backup(tmp_path: Path, mocker) -> None:
+    """Verify creating backups file with .bak extension."""
+    # Given a constant return from module.function
+    mock_function = mocker.patch('module.function')
+    mock_function.return_value = 'mocked'
+
+    # Given: A test file exists
+    file = tmp_path / "test.txt"
+    file.write_text("test")
+
+    # When: Creating a backup
+    backup_file(file)
+
+    # Then: Backup file exists and original is moved
+    expected_backup = file.parent / (file.name + ".bak")
+    assert expected_backup.exists()
+    assert not file.exists()
+```

datefind-0.1.0/.cursor/rules/python-docstring-rules.mdc

@@ -0,0 +1,39 @@
+---
+description: Writing python docstrings, Editing python docstrings
+globs: *.py
+alwaysApply: false
+---
+# Writing python docstrings
+
+Always follow these rules when writing Python docstrings
+
+1. Read and understand the entire function or class before writing the docstring
+2. Always use Google format docstrings
+3. Always include Types with arguments
+4. Do not document return when nothing is returned
+5. Only write in imperative voice. No Exceptions! 
+6. Never say "This function ..." Only use imperative voice.
+7. Docstrings should always be descriptive and explain why a developer would use the function, not just what it does
+8, Do not use line wraps and newlines within paragraphs.
+9. Do not included raised exceptions unless they are explicitly raised in the code
+
+## Examples of good python docstrings
+
+```python
+def read_config(path: Path = "config.toml", globs:list[str] | None = None) -> list[Path]:
+    """Read and validate the TOML configuration file that maps repository names to paths.
+
+    Search the given `path` for files matching any of the glob patterns provided in `globs`. If no globs are provided, returns all files in the directory.
+    
+    Args:
+        path (Path): The root directory where the search will be conducted.
+        globs (list[str] | None, optional): A list of glob patterns to match files (e.g., "*.txt", "*.py"). If None, returns all files. Defaults to None.
+
+    Returns:
+        list[Path]: A list of Path objects representing the files that match the glob patterns.
+
+    Raises:
+        cappa.Exit: If the config file doesn't exist, contains invalid TOML, or has invalid repository paths
+    """
+    ...
+```

datefind-0.1.0/.cursor/rules/python-naming-conventions.mdc

@@ -0,0 +1,12 @@
+---
+description: naming conventions for python
+globs: **/*.py
+alwaysApply: false
+---
+Always follow these standards for Python naming convention.
+
+- Use snake_case for variables.
+- Use snake_case for functions.
+- Use PascalCase for classes.
+- Use PascalCase for interfaces.
+- Use snake_case for files.

datefind-0.1.0/.cursor/rules/use-pathlib.mdc

@@ -0,0 +1,9 @@
+---
+description: Always use pathlib instead of the os module whenever possible
+globs: **/*.py
+alwaysApply: false
+---
+
+# Always use pathlib
+
+When writing Python code always use the `pathlib` module instead of the `os` module whenever possible.

datefind-0.1.0/.github/actions/setup_python_env/action.yml

@@ -0,0 +1,36 @@
+---
+name: Install uv, Python, and project dependencies
+description: Install uv, Python, and project dependencies using cached uv and Python installations
+
+inputs:
+  python-version:
+    description: >
+      Version range or exact version of a Python version to use, using SemVer's version range syntax.
+    required: false
+    default: "3.12"
+
+outputs:
+  python-version:
+    description: The installed python version. Useful when given a version range as input.
+    value: ${{ steps.setup-python.outputs.python-version }}
+
+runs:
+  using: composite
+  steps:
+    - name: Setup uv with cache
+      uses: astral-sh/setup-uv@v6
+      with:
+        version: "latest"
+        enable-cache: true
+
+    - name: Set up Python ${{ matrix.python-version }}
+      shell: bash
+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Install the project
+      shell: bash
+      run: uv sync --all-extras --dev
+
+    - name: Minimize uv cache
+      shell: bash
+      run: uv cache prune --ci

datefind-0.1.0/.github/dependabot.yml

@@ -0,0 +1,23 @@
+---
+version: 2
+
+updates:
+    - package-ecosystem: github-actions
+      directory: /
+      schedule:
+          interval: monthly
+      commit-message:
+          prefix: "ci"
+          prefix-development: "ci"
+          include: "scope"
+    # - package-ecosystem: pip
+    #   directory: /
+    #   schedule:
+    #       interval: monthly
+    #   commit-message:
+    #       prefix: "build"
+    #       prefix-development: "build"
+    #       include: "scope"
+    #   versioning-strategy: lockfile-only
+    #   allow:
+    #       - dependency-type: "all"

datefind-0.1.0/.github/workflows/commit-linter.yml

@@ -0,0 +1,35 @@
+---
+name: Commit Linter
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+        types:
+            - opened
+            - reopened
+            - synchronize
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+permissions: # added using https://github.com/step-security/secure-workflows
+    contents: read
+
+jobs:
+    lint-commits:
+        if: "!contains(github.event.head_commit.message, 'bump(release)')"
+        permissions:
+            contents: read # for actions/checkout to fetch code
+            pull-requests: read # for wagoid/commitlint-github-action to get commits in PR
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+
+            - name: Lint commits
+              uses: wagoid/commitlint-github-action@v6

datefind-0.1.0/.github/workflows/create-release.yml

@@ -0,0 +1,118 @@
+---
+name: "Create Release"
+
+on:
+    workflow_dispatch:
+    push:
+        tags:
+            - "v*"
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+
+permissions:
+    contents: write
+
+jobs:
+    auto-release:
+        name: Create Release
+        runs-on: "ubuntu-latest"
+        strategy:
+            fail-fast: true
+            matrix:
+                python-version: ["3.11"]
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+
+            - name: Setup Python, uv, and the package
+              uses: ./.github/actions/setup_python_env
+
+            # ----------------------------------------------
+            #    Grab version number
+            # ----------------------------------------------
+
+            - name: Add version to environment vars
+              run: |
+                  PROJECT_VERSION=$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')
+                  echo "PROJECT_VERSION=$PROJECT_VERSION" >> $GITHUB_ENV
+
+            # ----------------------------------------------
+            # Confirm we did, in fact, update the version
+            # ----------------------------------------------
+
+            - name: Check if tag version matches project version
+              run: |
+                  TAG=$(git describe HEAD --tags --abbrev=0)
+                  echo $TAG
+                  echo $PROJECT_VERSION
+                  if [[ "$TAG" != "v$PROJECT_VERSION" ]]; then exit 1; fi
+                  echo "CURRENT_TAG=refs/tags/${TAG}" >> $GITHUB_ENV
+
+            # ----------------------------------------------
+            # Test and then build the package
+            # ----------------------------------------------
+
+            - name: Run tests
+              shell: bash
+              run: uv run duty test
+
+            - name: Build the package
+              shell: bash
+              run: uv build
+
+            # ----------------------------------------------
+            # Generate release notes
+            # ----------------------------------------------
+
+            # - name: Release Notes
+            #   run: git log $(git describe HEAD~ --tags --abbrev=0)..HEAD --pretty='format:* %h %s' --no-merges >> ".github/RELEASE-TEMPLATE.md"
+
+            - name: Get notes
+              id: generate_notes
+              uses: anmarkoulis/commitizen-changelog-reader@master
+              with:
+                  tag_name: ${{ env.CURRENT_TAG }}
+                  changelog: CHANGELOG.md
+
+            # ----------------------------------------------
+            # Build draft release (Note: Will need to manually publish)
+            # ----------------------------------------------
+
+            - name: Create Github Release
+              uses: softprops/action-gh-release@v2
+              with:
+                  body: ${{join(fromJson(steps.generate_notes.outputs.notes).notes, '')}}
+                  draft: false
+                  files: |
+                      dist/*-${{env.PROJECT_VERSION}}-py3-none-any.whl
+                      dist/*-${{env.PROJECT_VERSION}}.tar.gz
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    publish-to-pypi:
+        runs-on: ubuntu-latest
+        needs: auto-release
+        env:
+            TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
+            TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
+        strategy:
+            matrix:
+                python-version: ["3.11"]
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup Python, uv, and the package
+              uses: ./.github/actions/setup_python_env
+
+            - name: Build the package
+              shell: bash
+              run: uv build
+
+            - name: Upload to PyPi
+              shell: bash
+              run: uvx twine upload dist/*

datefind-0.1.0/.github/workflows/manual_pypy_publish.yml

@@ -0,0 +1,36 @@
+---
+name: "Manual PyPy Publish"
+
+on:
+    workflow_dispatch:
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+
+permissions:
+    contents: write
+
+jobs:
+    publish-to-pypi:
+        runs-on: ubuntu-latest
+        env:
+            TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
+            TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
+        strategy:
+            matrix:
+                python-version: ["3.11"]
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup Python, uv, and the package
+              uses: ./.github/actions/setup_python_env
+
+            - name: Build the package
+              shell: bash
+              run: uv build
+
+            - name: Upload to PyPi
+              shell: bash
+              run: uvx twine upload dist/*

datefind-0.1.0/.github/workflows/pr-linter.yml

@@ -0,0 +1,50 @@
+---
+name: Pull Request Linter
+
+on:
+    pull_request_target:
+        types:
+            - opened
+            - edited
+            - synchronize
+        branches:
+            - main
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+permissions: # added using https://github.com/step-security/secure-workflows
+    contents: read
+
+jobs:
+    lint:
+        permissions:
+            pull-requests: read # for amannn/action-semantic-pull-request to analyze PRs
+            statuses: write # for amannn/action-semantic-pull-request to mark status of analyzed PR
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Lint Pull Request
+              uses: amannn/action-semantic-pull-request@v5
+              with:
+                  validateSingleCommit: true
+                  wip: true
+                  types: |
+                      fix
+                      feat
+                      docs
+                      style
+                      refactor
+                      perf
+                      test
+                      build
+                      ci
+                  requireScope: false
+                  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.
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

datefind-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,73 @@
+---
+name: "Tests"
+
+on:
+    workflow_dispatch:
+    push:
+        paths:
+            - ".github/workflows/test.yml"
+            - ".github/actions/**"
+            - "**.py"
+            - "pyproject.toml"
+            - "uv.lock"
+        branches:
+            - main
+    pull_request:
+        types:
+            - opened
+            - reopened
+            - synchronize
+        paths:
+            - ".github/workflows/test.yml"
+            - ".github/actions/**"
+            - "**.py"
+            - "pyproject.toml"
+            - "uv.lock"
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    test-python-code:
+        runs-on: ubuntu-latest
+        strategy:
+            fail-fast: true
+            matrix:
+                python-version: ["3.11", "3.12", "3.13"]
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup Python, uv, and the package
+              uses: ./.github/actions/setup_python_env
+
+            - name: Run tests
+              shell: bash
+              run: uv run duty test
+
+            - name: Upload coverage to Codecov
+              if: ${{ matrix.python-version == '3.12' }}
+              uses: codecov/codecov-action@v5
+              with:
+                  files: .cache/coverage.xml
+              env:
+                  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+    lint-project:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - uses: actions/cache@v4
+              with:
+                  path: ~/.cache/pre-commit
+                  key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+
+            - name: Setup Python, uv, and the package
+              uses: ./.github/actions/setup_python_env
+
+            - name: run all linters
+              shell: bash
+              run: uv run duty lint

datefind-0.1.0/.gitignore

@@ -0,0 +1,56 @@
+# Scratch folder for temporary files
+scratch/
+tmp/
+development/
+.development/
+dev-config.toml
+
+# Caches
+*_cache/
+__pycache__/
+.cache/
+
+# Coverage.py
+htmlcov/
+reports/
+.reports/
+
+# cruft
+*.rej
+
+# Data
+*.csv*
+*.dat*
+*.pickle*
+*.xls*
+*.zip*
+
+.envrc
+.env
+
+# Jupyter
+*.ipynb
+.ipynb_checkpoints/
+notebooks/
+
+# macOS
+.DS_Store
+
+# mypy
+.dmypy.json
+
+# Node.js
+node_modules/
+
+# Poetry
+.venv/
+dist/
+
+# PyCharm
+.idea/
+
+# Python
+*.py[cdo]
+
+# act run workflows locally
+bin/act