Feat: PyPI Upload Prep #1
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updates project name from Name Visualizer to Encoderize. This change reflects a broader scope of functionality, encompassing various encoding methods for generating visual representations of text. Updates documentation, CLI entry point, package name, tests, and setup configuration to reflect the new name. Also bumps the minimum Python version to 3.8.
Moves issue and PR templates out of workflows The issue and pull request templates are not workflow specific and should reside in the root .github directory. This change moves them to the appropriate location.
Renames the workflow to "Python Encoderize" and adds a step to upload coverage reports to Codecov. This enhances the CI process by integrating coverage tracking.
Adds support for multiple Python versions (3.9, 3.10, 3.11) using a matrix strategy. Updates the setup step to cache pip dependencies and includes coverage report generation with pytest. This improves the CI process by ensuring compatibility across different Python versions and integrating coverage tracking. Enhances Python CI workflow Adds support for multiple Python versions (3.9, 3.10, 3.11) using a matrix strategy. Caches pip dependencies to speed up the CI process. Includes coverage report generation with pytest and uploads to Codecov. This improves CI by ensuring compatibility across different Python versions and integrating coverage tracking.
…overage report handling Changes the Codecov action version to v5 and updates the upload step to include the necessary token and slug for better integration. This enhances the coverage reporting process in the CI workflow.
There was a problem hiding this comment.
Pull Request Overview
This PR updates all project references from "name_visualizer" to "encoderize" to prepare for a PyPI upload. Key changes include:
- Renaming modules and updating corresponding test files and CLI documentation.
- Updating package configuration files (setup.py, pyproject.toml, README.md) with new keywords, version, license, and dependency information.
- Enhancing the CI pipeline with a multi-Python version test matrix and improved coverage reporting.
Reviewed Changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_visualizers.py | Updated test descriptions and import path replacements. |
| tests/test_cli.py | Updated CLI test descriptions and module imports. |
| setup.py | Added keywords, updated license, and entry point references. |
| pyproject.toml | Added build system configuration for packaging. |
| encoderize/visualizers.py | Updated module docstring from name_visualizer to encoderize. |
| encoderize/cli.py | Updated CLI docstring to reflect new package name. |
| encoderize/init.py | Added version information and removed duplicate header. |
| README.md | Renamed and updated documentation, badges, and requirements. |
| .github/workflows/python-app.yml | Updated workflow name, test matrix, caching, and reporting. |
| .github/PULL_REQUEST_TEMPLATE.md | Added new pull request template. |
| .github/ISSUE_TEMPLATE.md | Added new issue template. |
Files not reviewed (1)
- pytest.ini: Language not supported
Comments suppressed due to low confidence (1)
.github/workflows/python-app.yml:15
- The test matrix currently covers Python 3.9, 3.10, and 3.11, but the README specifies support for Python 3.8 or higher. Consider adding Python 3.8 to the test matrix so that the tests align with the documented minimum version.
strategy:
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment Thanks for integrating Codecov - We've got you covered ☂️ |
Adds Python 3.8 to the matrix of supported versions in the CI workflow, ensuring compatibility with an earlier version of Python.
Modifies the setuptools requirement to specify version constraints based on Python version, ensuring compatibility with Python 3.8.
There was a problem hiding this comment.
Pull Request Overview
This PR prepares the package for a PyPI upload by renaming the package references from name_visualizer to encoderize and updating metadata and CI configurations.
- Updated all module and documentation references from name_visualizer to encoderize
- Adjusted package metadata in setup.py and added build system configuration in pyproject.toml
- Enhanced the GitHub Actions workflow with a expanded test matrix and coverage reporting
Reviewed Changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_visualizers.py | Renamed module references to encoderize |
| tests/test_cli.py | Updated CLI tests to use the encoderize command |
| setup.py | Updated metadata (keywords and license field) |
| pyproject.toml | Added build-system configuration for setuptools and wheel |
| encoderize/visualizers.py & encoderize/cli.py | Updated module docstrings to refer to encoderize instead of name_visualizer |
| encoderize/init.py | Removed obsolete documentation and added version |
| README.md | Updated documentation and usage examples to refer to encoderize |
| .github/workflows/python-app.yml | Enhanced workflow configuration with branch patterns and multi-Python testing |
| .github/PULL_REQUEST_TEMPLATE.md, .github/ISSUE_TEMPLATE.md | Added standardized templates for PRs and issues |
Files not reviewed (1)
- pytest.ini: Language not supported
Comments suppressed due to low confidence (2)
setup.py:20
- The removal of the license classifier might affect how the package is displayed on PyPI. Consider reintroducing the license classifier in addition to the 'license' field to maintain complete metadata.
"License :: OSI Approved :: MIT License",
.github/workflows/python-app.yml:5
- Using a branch pattern of "**" will trigger the workflow for all branches. Confirm that this is intentional, as it may result in unnecessary builds on non-main branches.
branches: ["**"]
Restricts the push branch to main in the GitHub Actions workflow to prevent accidental deployments from other branches. Adds "License :: OSI Approved :: MIT License" classifier to setup.py to clarify the project's licensing.
…lude 3.12 and 3.13 Expands the supported Python versions in the CI workflow to include 3.12 and 3.13, ensuring compatibility with the latest Python releases.
…thon compatibility Updates the coverage package requirements to specify different versions based on the Python version, ensuring compatibility with Python 3.8
…thon compatibility Modifies the docutils package requirements to specify different versions based on the Python version, ensuring compatibility with Python 3.8
…hon compatibility Modifies the keyring package requirements to specify different versions based on the Python version, ensuring compatibility with Python 3.8
…on compatibility Modifies the pillow package requirements to specify different versions based on the Python version, ensuring compatibility with Python 3.8
Adds a new job to the CI workflow that runs flake8 to lint the code. Also adds a version constraint for setuptools to ensure compatibility with Python 3.8
…thon compatibility Modifies the treepoem package requirements to specify different versions based on the Python version, ensuring compatibility with Python 3.8
Refactors the GitHub Actions workflow to enhance the linting and testing process. This includes setting up Python, installing dependencies, and running flake8 for linting and pytest for testing with coverage reporting. The changes ensure a more structured and efficient CI pipeline.
Changes the Python version in the GitHub Actions workflow from '3.x' to '3.13' to ensure the CI pipeline uses the latest stable release.
There was a problem hiding this comment.
Pull Request Overview
This PR prepares the package for PyPI upload by renaming the project from "name_visualizer" to "encoderize" and updating the associated configurations, documentation, and workflows.
- Updated import statements, documentation comments, and CLI references to reflect the new project name ("encoderize").
- Added configuration files (pyproject.toml) and refined setup.py with new keywords, license, and entry points.
- Enhanced GitHub workflows to support multiple Python versions, caching pip dependencies, linting, testing with coverage, and added PR/issue templates.
Reviewed Changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_visualizers.py | Updated test descriptions and import paths to reference encoderize. |
| tests/test_cli.py | Updated CLI tests to use encoderize instead of name_visualizer. |
| setup.py | Adjusted metadata, keywords, license, and entry point for encoderize. |
| pyproject.toml | Introduced build-system configuration for different Python versions. |
| encoderize/visualizers.py | Updated module docstring to reference encoderize. |
| encoderize/cli.py | Updated CLI description to reference encoderize. |
| encoderize/init.py | Moved version declaration and removed duplicate package comments. |
| README.md | Updated project name, badges, CLI usage example, and Python requirement. |
| .github/workflows/python-app.yml | Overhauled workflow with multi-Python version support, caching, linting, and test coverage reporting. |
| .github/PULL_REQUEST_TEMPLATE.md | Added a new PR template for better PR submissions. |
| .github/ISSUE_TEMPLATE.md | Added a new issue template to standardize issue reporting. |
Files not reviewed (1)
- pytest.ini: Language not supported
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.