Skip to content

Conversation

@amilworks
Copy link
Member

Improve Development Workflow and Packaging Setup

PR Description:

This PR introduces several improvements to our repository to enhance code quality, streamline development, and improve our PyPI packaging:

  1. Pre-commit Hooks and GitHub Actions Workflow:

    • Pre-commit Configuration:
      Added a new .pre-commit-config.yaml file to enforce code quality standards using popular hooks such as Black, isort, flake8, and additional hooks for cleaning up trailing whitespace, fixing end-of-file issues, and validating YAML files.
    • GitHub Workflow:
      Created a GitHub Actions workflow at .github/workflows/pre-commit.yml that runs pre-commit checks on every push or pull request to the main branch. This ensures that our code consistently adheres to style and linting rules before it is merged.
  2. Python Code Syntax Update (very naive):

    • Automatic Syntax Upgrade:
      We discussed and integrated tools like pyupgrade (or 2to3) to facilitate the transition from Python 2 syntax to Python 3 syntax in way too meetings. These tools help automatically convert legacy syntax (e.g., Python 2 print statements) to Python 3, ensuring our codebase is fully compatible with modern Python versions.
    • Black Formatting:
      Clarified the usage of Black for automatically rewriting and formatting our source code. We now have hopefully will have a consistent code style.

These changes should make the development process smoother and ensure our package maintains a high standard of code quality and packaging metadata.

@amilworks amilworks self-assigned this Apr 11, 2025
@amilworks amilworks added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Apr 11, 2025
@amilworks amilworks merged commit 60c3547 into main Apr 11, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants