Python utils for everyday use.
Project description
Python Humble Utils
===================
.. image:: https://travis-ci.org/webyneter/python-humble-utils.svg?branch=master
:target: https://travis-ci.org/webyneter/python-humble-utils
:alt: Build Status
.. image:: https://badge.fury.io/py/python-humble-utils.svg
:target: https://pypi.python.org/pypi/python-humble-utils
:alt: Latest Version
.. image:: https://img.shields.io/pypi/pyversions/python-humble-utils.svg
:target: https://pypi.python.org/pypi/python-humble-utils
:alt: Supported Python Versions
.. image:: https://codecov.io/gh/webyneter/python-humble-utils/branch/master/graph/badge.svg
:target: https://codecov.io/gh/webyneter/python-humble-utils
:alt: Coverage
.. image:: https://pyup.io/repos/github/webyneter/python-humble-utils/shield.svg
:target: https://pyup.io/repos/github/webyneter/python-humble-utils/
:alt: Updates
.. image:: https://readthedocs.org/projects/python-humble-utils/badge/?version=latest
:target: http://python-humble-utils.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/License-MIT-green.svg
:target: https://opensource.org/licenses/MIT
:alt: MIT License
Python utils for everyday use.
* `Documentation`_.
* Please, `open issues`_ before sending emails to the maintainers: You will get a much faster response!
.. _`open issues`: https://github.com/webyneter/python_humble_utils/issues/new
.. _`Documentation`: https://python-humble-utils.readthedocs.io/en/stable/
Feature Areas
-------------
* File operations.
* File/directory paths extraction.
* File/directory paths randomization.
* String case convertions.
* Python class convenience shortcuts.
* `py.test`_ fixtures and helpers.
.. _py.test: https://docs.pytest.org/en/stable/
Installation
------------
.. code-block:: console
$ pip install python-humble-utils
or install from sources:
.. code-block:: console
$ python setup.py install
Refer to Installation for detailed instructions.
.. TODO Refer to :ref:`installation`.
Usage
-----
.. code-block:: python
import os
from python_humble_utils.commands import (
yield_file_paths,
camel_or_pascal_case_to_snake_case
)
# ...
file_paths = yield_file_paths(dir_path=os.path.join('dir', 'with', 'scripts'),
allowed_file_extensions=['.sh', '.bash'],
recursively=True)
# assert set(file_paths) == set(['s1.sh', 's2.bash', 's3.bash'])
s = camel_or_pascal_case_to_snake_case('camelCasedString')
# assert s == 'camel_cased_string'
s = camel_or_pascal_case_to_snake_case('PascalCasedString')
# assert s == 'pascal_cased_string'
# ...
Contributing
------------
Your contributions are very much welcome! Refer to :ref:`contributing` for more details.
Code of Conduct
---------------
All those using `python-humble-utils`, including its codebase and project management ecosystem are expected to follow the `Python Community Code of Conduct`_.
.. _`Python Community Code of Conduct`: https://www.python.org/psf/codeofconduct/
Acknowledgements
----------------
This package was scaffolded via Cookiecutter_ with `audreyr/cookiecutter-pypackage`_ template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
History
=======
0.1.0 (2017-06-18)
------------------
* First release on PyPI.
===================
.. image:: https://travis-ci.org/webyneter/python-humble-utils.svg?branch=master
:target: https://travis-ci.org/webyneter/python-humble-utils
:alt: Build Status
.. image:: https://badge.fury.io/py/python-humble-utils.svg
:target: https://pypi.python.org/pypi/python-humble-utils
:alt: Latest Version
.. image:: https://img.shields.io/pypi/pyversions/python-humble-utils.svg
:target: https://pypi.python.org/pypi/python-humble-utils
:alt: Supported Python Versions
.. image:: https://codecov.io/gh/webyneter/python-humble-utils/branch/master/graph/badge.svg
:target: https://codecov.io/gh/webyneter/python-humble-utils
:alt: Coverage
.. image:: https://pyup.io/repos/github/webyneter/python-humble-utils/shield.svg
:target: https://pyup.io/repos/github/webyneter/python-humble-utils/
:alt: Updates
.. image:: https://readthedocs.org/projects/python-humble-utils/badge/?version=latest
:target: http://python-humble-utils.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/License-MIT-green.svg
:target: https://opensource.org/licenses/MIT
:alt: MIT License
Python utils for everyday use.
* `Documentation`_.
* Please, `open issues`_ before sending emails to the maintainers: You will get a much faster response!
.. _`open issues`: https://github.com/webyneter/python_humble_utils/issues/new
.. _`Documentation`: https://python-humble-utils.readthedocs.io/en/stable/
Feature Areas
-------------
* File operations.
* File/directory paths extraction.
* File/directory paths randomization.
* String case convertions.
* Python class convenience shortcuts.
* `py.test`_ fixtures and helpers.
.. _py.test: https://docs.pytest.org/en/stable/
Installation
------------
.. code-block:: console
$ pip install python-humble-utils
or install from sources:
.. code-block:: console
$ python setup.py install
Refer to Installation for detailed instructions.
.. TODO Refer to :ref:`installation`.
Usage
-----
.. code-block:: python
import os
from python_humble_utils.commands import (
yield_file_paths,
camel_or_pascal_case_to_snake_case
)
# ...
file_paths = yield_file_paths(dir_path=os.path.join('dir', 'with', 'scripts'),
allowed_file_extensions=['.sh', '.bash'],
recursively=True)
# assert set(file_paths) == set(['s1.sh', 's2.bash', 's3.bash'])
s = camel_or_pascal_case_to_snake_case('camelCasedString')
# assert s == 'camel_cased_string'
s = camel_or_pascal_case_to_snake_case('PascalCasedString')
# assert s == 'pascal_cased_string'
# ...
Contributing
------------
Your contributions are very much welcome! Refer to :ref:`contributing` for more details.
Code of Conduct
---------------
All those using `python-humble-utils`, including its codebase and project management ecosystem are expected to follow the `Python Community Code of Conduct`_.
.. _`Python Community Code of Conduct`: https://www.python.org/psf/codeofconduct/
Acknowledgements
----------------
This package was scaffolded via Cookiecutter_ with `audreyr/cookiecutter-pypackage`_ template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
History
=======
0.1.0 (2017-06-18)
------------------
* First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
python-humble-utils-0.4.0.tar.gz
(17.6 kB
view hashes)
Built Distribution
Close
Hashes for python-humble-utils-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b397dccad25cf53ad6388db9d7fb87509e1f3d11591861def317ed87e130ca94 |
|
MD5 | 90cc2e217909677d9e57c16ac8daa2fd |
|
BLAKE2b-256 | 87d53260e3885b7e5d892694099b0ec90ec731356e3c3c01b424a9561c1e48c1 |
Close
Hashes for python_humble_utils-0.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a29177bd519b3fccba0955dd6c6b9e0b49d1be9078800fa73f9f5e0aaf469453 |
|
MD5 | e4a30ed8d4d6d1180a790fc94d503a64 |
|
BLAKE2b-256 | 831afeb79cbccfcaaf78d92f5e76d009b9e587d96af052b10b7780e1c41c403e |