Chore: Update README Header #2
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.
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.
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.
Introduces a new CONTRIBUTING.md file to guide users on reporting bugs, suggesting enhancements, and submitting pull requests. Updates the README.md to improve formatting, enhance feature descriptions, and clarify usage instructions, including example visualizations and options for generating outputs.
There was a problem hiding this comment.
Pull Request Overview
This PR rebrands the project from "name_visualizer" to "encoderize" while rearranging the badges and centering the title in the README. Key changes include:
- Updates to test, CLI, and module documentation to reflect the new "encoderize" name.
- Adjustments in setup files, build configurations, and GitHub workflows.
- Introduction of a CONTRIBUTING.md file and updated issue/PR templates.
Reviewed Changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_visualizers.py | Updated module references from name_visualizer to encoderize |
| tests/test_cli.py | Updated CLI module references to encoderize |
| setup.py | Replaced entry point and added keywords and license metadata |
| pyproject.toml | Added and configured new build system settings |
| encoderize/visualizers.py | Updated header documentation reflecting rebranding |
| encoderize/cli.py | Updated header documentation reflecting rebranding |
| encoderize/init.py | Moved and updated version information and removed legacy text |
| README.md | Rearranged badges and centered the title with updated usage instructions |
| CONTRIBUTING.md | Added new guidelines for contributing |
| .github/workflows/python-app.yml | Updated workflow settings, added a Python version matrix, and caching |
| .github/PULL_REQUEST_TEMPLATE.md | Added 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)
encoderize/cli.py:9
- [nitpick] Consider using an explicit mapping from visualization functions to output file names instead of slicing the function names; this approach is more robust if the naming convention changes in the future.
filename = os.path.join(args.output_dir, f"{f.__name__[9:]}.svg")
|
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
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.
Description
This PR is to rearrange the badges and center the title.
Type of Change
Checklist
How Has This Been Tested?
Not needed.
Screenshots (if applicable)
Additional Context