BREAKING CHANGES!: refactor setup.py to pyproject.toml and many more … #29
Conversation
…changes to project folder structure.
bybatkhuu
added
major
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive modernization and automation improvements to the Python logging project, transitioning from setup.py to pyproject.toml and establishing robust development workflows. The changes focus on updating project configuration, enhancing CI/CD pipelines, and improving developer experience through automation and tooling.
- Migration from setup.py to modern pyproject.toml configuration with dynamic dependencies
- Addition of comprehensive GitHub Actions workflows for version bumping, building, publishing, and changelog management
- Introduction of pre-commit hooks, development tooling, and documentation infrastructure
Reviewed Changes
Copilot reviewed 99 out of 121 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| setup.py | Simplified to minimal setuptools call, moving configuration to pyproject.toml |
| pyproject.toml | New modern Python packaging configuration with dynamic dependencies |
| scripts/* | Updated shell scripts removing base.sh dependency and improving error handling |
| .github/workflows/* | New automated workflows for CI/CD, documentation, and changelog management |
| requirements/* | Restructured dependency files into organized directory structure |
| docs/* | Complete documentation infrastructure with MkDocs configuration |
| .vscode/* | Enhanced VS Code workspace configuration and extension recommendations |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| try: | ||
| nested(0) | ||
| except Exception as err: | ||
| except Exception: |
There was a problem hiding this comment.
Good practice to use bare 'Exception' instead of capturing unused variable 'err' when the exception is not used in the except block.
This pull request introduces a comprehensive set of updates focused on improving development workflows, automation, and project configuration. The most important changes include the addition of new GitHub Actions workflows for changelog updates and documentation publishing, enhancements to CI/CD pipelines, the introduction of pre-commit hooks for code quality and security, and updates to development environment settings for consistency and best practices.
Automation & CI/CD Improvements:
3.update-changelog.yml) and documentation publishing (publish-docs.yml), streamlining release and documentation processes. [1] [2]1.bump-version.yml,2.build-publish.yml) to use newer runner versions, updated actions, improved dependency installation, and added version fetching steps for more robust builds and releases. [1] [2] [3]Code Quality & Security:
.pre-commit-config.yamlwith a wide range of hooks for code formatting, linting, security checks, and shell script validation, helping to maintain code quality and prevent common issues..markdownlint.jsonto disable additional markdown linting rules for more flexible documentation formatting.Development Environment & Tooling:
extensions.json,settings.json) to recommend relevant extensions, enforce consistent formatting, and optimize workspace settings for Python and documentation development. [1] [2]3.10) in.python-versionfor consistent local development and CI environments.Project Metadata & Packaging:
LICENSE.txtcopyright year to 2025 and improvedREADME.mdbadges and descriptions for clarity. [1] [2]MANIFEST.into control package contents, excluding unnecessary files and directories from distribution.Makefilewith common development commands to simplify local workflow.Ownership & Dependency Management:
CODEOWNERSfor repository ownership and addeddependabot.ymlto automate dependency updates for Python packages. [1] [2]These changes collectively improve the project's maintainability, developer experience, and automation.