GeekMasher's Open Source Python Utilities Library
GMUtils is used to assist Python developers perform certain tasks quicker then before with many standard utilities built in.
Check out geekmasher.github.io/GMUtils/ for more details.
Install is as simple as:
python3 ./setup.py installNote: This might require root access to install
I use Sphinx to build my docs, this requires both Sphinx and GMUtils module to be installed on the system to build the docs.
To install Sphinx:
# Debian/Ubuntu
apt-get install python3-sphinx
# RHEL/CentOS
yum install python-sphinxOnce installed, simply run:
sphinx-build -b html docs/ docs/_buildI'm currently hosting the GMUtils on Github Pages
gh-pages -d docs/_build/ -tPlease find document at geekmasher.github.io/GMUtils/
I do love unit tests and making sure my software is as reliable as possible without breaking my own and other peoples code.
Run unit tests:
python3 -m unittest discover -s 'tests' -p "test_*.py"If you wish to contribute to the GMUtils library, please reach out to @GeekMasher on Twitter or send a pull request.
MIT License
Copyright (c) 2018 Mathew Payne
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.