Skip to content

feat: Add MIT License and Pre-commit Configuration #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Jul 25, 2025
Merged

feat: Add MIT License and Pre-commit Configuration #1

merged 2 commits into from
Jul 25, 2025

Conversation

jaseemjaskp
Copy link
Contributor

Summary

This PR adds essential project infrastructure components:

  • MIT License file for proper legal licensing
  • Comprehensive pre-commit configuration for code quality enforcement

Changes

📄 License

  • Added: file with MIT License terms
  • Copyright: 2025 Unstract Team (consistent with pyproject.toml)
  • Compliance: Matches existing classifier

🔧 Pre-commit Configuration

  • Added: with comprehensive hooks:
    • Code Quality: trailing whitespace, end-of-file-fixer, YAML/TOML validation
    • Python Tools: Ruff (linting + formatting), MyPy (type checking), Bandit (security)
    • Formatting: Prettier for YAML/Markdown/JSON files
  • Configured: MyPy with appropriate type stub dependencies
  • Security: Bandit with project-appropriate exclusions (B113 timeout warnings)
  • Installation: Pre-commit hooks installed and tested

⚙️ Configuration Updates

  • pyproject.toml: Added configuration section
  • README.md: Updated development setup section to use and include pre-commit instructions

Motivation

  • Legal Compliance: Proper MIT licensing ensures clear usage terms for users and contributors
  • Code Quality: Pre-commit hooks enforce consistent code style and catch issues before commits
  • Developer Experience: Standardized tooling reduces onboarding friction and maintains code standards
  • CI/CD Ready: Hooks align with existing project tools (Ruff, MyPy) for seamless integration

Testing

  • ✅ Pre-commit hooks installed successfully
  • ✅ All hooks pass on existing codebase
  • ✅ License file properly formatted
  • ✅ Configuration files validated (YAML, TOML)
  • ✅ Integration with existing workflow confirmed

Checklist

  • Code follows project style guidelines (enforced by pre-commit)
  • Self-review completed
  • Documentation updated (README.md development section)
  • No breaking changes introduced
  • All existing tests pass
  • New configuration files properly formatted
  • Pre-commit hooks installed and working

Additional Notes

  • Follows project guidelines from (uses , not )
  • Pre-commit configuration is tuned for the project's needs
  • All hooks tested and passing on current codebase
  • Ready for immediate use by development team

@jaseemjaskp
feat: add MIT license and pre-commit configuration
3a118d2 
- Add MIT License file with Unstract Team copyright
- Add comprehensive pre-commit configuration with:
  - Ruff for linting and formatting
  - MyPy for type checking
  - Bandit for security scanning
  - Standard hooks for code quality
- Update pyproject.toml with bandit configuration
- Update README.md development setup to use uv and include pre-commit
- Install and configure pre-commit hooks

This ensures consistent code quality and proper licensing for the project.
@jaseemjaskp jaseemjaskp self-assigned this Jul 25, 2025
@jaseemjaskp jaseemjaskp added enhancement New feature or request documentation Improvements or additions to documentation labels Jul 25, 2025
@jaseemjaskp
fix: resolve import sorting issues in test files
9cceca3 
- Fixed I001 import block formatting errors in test_client.py
- Fixed I001 import block formatting errors in test_integration.py
- Fixed I001 import block formatting errors in test_performance.py
- All imports now properly organized: stdlib, third-party, local
- Added proper spacing between import groups
- Resolves tox lint failures
@github-actions GitHub Actions
Copy link
Contributor

🧪 Test Report

Test Results

Test Environment

  • Python Version: 3.12
  • OS: Ubuntu Latest
  • Tox Environment: py312

Status

✅ All tests passed successfully!

@jaseemjaskp jaseemjaskp merged commit 6dff597 into main Jul 25, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@jaseemjaskp jaseemjaskp

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@jaseemjaskp