This pull request introduces a new utility script, updates to our project's structure, and enhancements to the development workflow. The following list summarizes the key changes and additions:
Added
A new utility module:
util/conv.py: A script designed to automatically generate a stub file from the cheatsheet.txt located in the project's root directory.
Project structure updates:
pyMeow/__init__.py: An initialization file for the pyMeow package.
pyMeow/pyMeow.pyi: A generated stub file that provides type hints and function signatures.
Modified
cheatsheet.txt: Updated for compatibility with conv.py to ensure accurate stub generation.
Project Setup
setup.py: Added to define package distribution.
.gitignore: Updated to include new patterns specific to our latest changes.
GitHub Actions
Created a new GitHub Action workflow to automate the building and packaging process across different operating systems and streamline our CI/CD pipeline. Its currently on manual mode but i tested it.
Testing
The util/conv.py script has been tested locally to verify that it generates the pyMeow.pyi stub file correctly.
The GitHub Action has been triggered and successfully builds the package, indicating that our CI/CD pipeline is functioning as intended.
Please review the changes and provide your feedback. If there are any specific areas you would like me to focus on or any additional tests you recommend, let me know!
Pull Request: Utility Script and Stub Generation
Overview
This pull request introduces a new utility script, updates to our project's structure, and enhancements to the development workflow. The following list summarizes the key changes and additions:
Added
A new utility module:
util/conv.py: A script designed to automatically generate a stub file from thecheatsheet.txtlocated in the project's root directory.Project structure updates:
pyMeow/__init__.py: An initialization file for thepyMeowpackage.pyMeow/pyMeow.pyi: A generated stub file that provides type hints and function signatures.Modified
cheatsheet.txt: Updated for compatibility withconv.pyto ensure accurate stub generation.Project Setup
setup.py: Added to define package distribution..gitignore: Updated to include new patterns specific to our latest changes.GitHub Actions
Testing
util/conv.pyscript has been tested locally to verify that it generates thepyMeow.pyistub file correctly.Please review the changes and provide your feedback. If there are any specific areas you would like me to focus on or any additional tests you recommend, let me know!