Project Setup with Codespace

Author: anthonycamilleri

.devcontainer/devcontainer.json

@@ -0,0 +1,72 @@
+{
+  "name": "docprocessor Library Development",
+  "image": "mcr.microsoft.com/devcontainers/python:3.11",
+
+  "features": {
+    "ghcr.io/devcontainers/features/python:1": {
+      "version": "3.11"
+    }
+  },
+
+  "postCreateCommand": "chmod +x .devcontainer/setup.sh && .devcontainer/setup.sh",
+
+  "containerEnv": {
+    "PYTHONPATH": "${containerWorkspaceFolder}"
+  },
+
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python",
+        "ms-python.black-formatter",
+        "ms-python.isort",
+        "ms-python.flake8",
+        "eamodio.gitlens",
+        "mhutchie.git-graph",
+        "davidanson.vscode-markdownlint",
+        "redhat.vscode-yaml"
+      ],
+
+      "settings": {
+        // Python interpreter
+        "python.defaultInterpreterPath": "/usr/local/python/current/bin/python",
+
+        // Type checking
+        "python.analysis.typeCheckingMode": "basic",
+
+        // Testing setup
+        "python.testing.pytestEnabled": true,
+        "python.testing.unittestEnabled": false,
+        "python.testing.pytestArgs": ["tests"],
+        "python.testing.cwd": "${containerWorkspaceFolder}",
+
+        // Code formatting on save
+        "editor.formatOnSave": true,
+        "editor.codeActionsOnSave": {
+          "source.organizeImports": "always"
+        },
+
+        "[python]": {
+          "editor.defaultFormatter": "ms-python.black-formatter",
+          "editor.formatOnSave": true
+        },
+
+        // Black formatter
+        "black-formatter.args": ["--line-length", "100"],
+
+        // isort
+        "isort.args": ["--profile", "black", "--line-length", "100"],
+
+        // flake8
+        "flake8.args": [
+          "--max-line-length=100",
+          "--extend-ignore=E203,W503"
+        ]
+      }
+    }
+  },
+
+  "remoteEnv": {
+    "PYTHONPATH": "${containerWorkspaceFolder}"
+  }
+}

.devcontainer/setup.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+set -e
+
+echo "🚀 Setting up docprocessor development environment..."
+
+# Update package lists
+echo "📦 Updating package lists..."
+sudo apt-get update
+
+# Install system dependencies for document processing
+echo "🔧 Installing system dependencies..."
+sudo apt-get install -y \
+    tesseract-ocr \
+    tesseract-ocr-eng \
+    poppler-utils \
+    libgl1-mesa-glx \
+    libglib2.0-0
+
+# Upgrade pip
+echo "⬆️ Upgrading pip..."
+python -m pip install --upgrade pip
+
+# Install package in editable mode with dev dependencies
+echo "📚 Installing docprocessor with dev dependencies..."
+pip install -e ".[dev]"
+
+# Install pre-commit hooks
+echo "🪝 Installing pre-commit hooks..."
+if [ -f ".pre-commit-config.yaml" ]; then
+    pip install pre-commit
+    pre-commit install
+    echo "✅ Pre-commit hooks installed"
+else
+    echo "⚠️ No .pre-commit-config.yaml found, skipping pre-commit setup"
+fi
+
+# Run tests to verify setup
+echo "🧪 Running tests to verify setup..."
+if pytest --version > /dev/null 2>&1; then
+    pytest tests/ -v || echo "⚠️ Some tests failed, but setup is complete"
+else
+    echo "⚠️ pytest not found, skipping test verification"
+fi
+
+echo ""
+echo "✅ Setup complete!"
+echo ""
+echo "Next steps:"
+echo "  • Run tests: pytest"
+echo "  • Run tests with coverage: pytest --cov=docprocessor"
+echo "  • Format code: black docprocessor tests"
+echo "  • Sort imports: isort docprocessor tests"
+echo "  • Type check: mypy docprocessor"
+echo ""

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,58 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+## Bug Description
+
+<!-- A clear and concise description of what the bug is -->
+
+## To Reproduce
+
+Steps to reproduce the behavior:
+
+1.
+2.
+3.
+
+**Minimal Code Example:**
+
+```python
+from docprocessor import DocumentProcessor
+
+# Your code here
+```
+
+## Expected Behavior
+
+<!-- A clear and concise description of what you expected to happen -->
+
+## Actual Behavior
+
+<!-- What actually happened -->
+
+## Error Message
+
+```
+Paste the full error message and stack trace here
+```
+
+## Environment
+
+- **OS**: [e.g., Ubuntu 22.04, macOS 14, Windows 11]
+- **Python Version**: [e.g., 3.11.5]
+- **docprocessor Version**: [e.g., 1.0.0]
+- **Installation Method**: [pip, git, other]
+
+**System Dependencies:**
+- Tesseract version: [run `tesseract --version`]
+- Poppler version: [run `pdfinfo -v`]
+
+## Additional Context
+
+<!-- Add any other context about the problem here -->
+
+<!-- Include relevant files, screenshots, or logs if applicable -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,49 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+---
+
+## Feature Description
+
+<!-- A clear and concise description of the feature you'd like to see -->
+
+## Use Case
+
+<!-- Describe the problem this feature would solve -->
+
+**Is your feature request related to a problem?**
+
+<!-- e.g., I'm always frustrated when... -->
+
+## Proposed Solution
+
+<!-- Describe the solution you'd like -->
+
+**API Design (if applicable):**
+
+```python
+# Example of how you envision using this feature
+from docprocessor import DocumentProcessor
+
+processor = DocumentProcessor()
+result = processor.your_new_feature(...)
+```
+
+## Alternatives Considered
+
+<!-- Describe alternative solutions or features you've considered -->
+
+## Additional Context
+
+<!-- Add any other context, screenshots, or examples about the feature request here -->
+
+## Implementation Willingness
+
+<!-- Would you be willing to contribute the implementation? -->
+
+- [ ] I'm willing to implement this feature
+- [ ] I can help with testing
+- [ ] I need help implementing this

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,67 @@
+## Description
+
+<!-- Provide a brief description of the changes in this PR -->
+
+## Type of Change
+
+<!-- Mark the relevant option with an 'x' -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Code quality improvement (refactoring, type hints, tests)
+- [ ] Performance improvement
+- [ ] Dependency update
+
+## Related Issues
+
+<!-- Link related issues here using #issue_number -->
+
+Fixes #
+Relates to #
+
+## Changes Made
+
+<!-- Provide a detailed list of changes -->
+
+-
+-
+-
+
+## Testing
+
+<!-- Describe the tests you ran and how to reproduce them -->
+
+- [ ] All existing tests pass
+- [ ] Added new tests for changes
+- [ ] Manual testing performed
+
+### Test Coverage
+
+```bash
+# Include test coverage output
+pytest --cov=docprocessor
+```
+
+## Checklist
+
+<!-- Mark completed items with an 'x' -->
+
+- [ ] My code follows the code style of this project (Black, isort, flake8)
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published
+- [ ] I have updated the CHANGELOG.md
+
+## Screenshots (if applicable)
+
+<!-- Add screenshots to help explain your changes -->
+
+## Additional Context
+
+<!-- Add any other context about the PR here -->