python-humble-utils 3.1.0

Python utils for everyday use.

Python Humble Utils

Python utils for everyday use.

• Documentation.
• Please, open issues before sending emails to the maintainers: You will get a much faster response!

Feature Areas

• File operations.
• File/directory paths extraction.
• File/directory paths randomization.
• String case conversions.
• Python class convenience shortcuts.
• py.test fixtures and helpers.

Installation

$ pip install python-humble-utils

or install from sources:

$ python setup.py install

Refer to Installation for detailed instructions.

Usage

import os
from pathlib import Path

from python_humble_utils.filesystem import yield_file_paths
from python_humble_utils.strings import camel_or_pascal_case_to_snake_case


# ...

file_paths = yield_file_paths(
    dir_path=Path("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 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.

Acknowledgements

This package was initially scaffolded via Cookiecutter with audreyr/cookiecutter-pypackage template.

History

v3.0.1

v3.0.1.

• Sync usage guides.
• Update `HISTORY.rst.

v3.0.0

v3.0.0.

Breaking changes:

• The following functions have been removed as part of the Remove redundant utilities/utilities making no sense effort:

  • extract_file_name_with_extension
  • extract_file_name_and_extension
  • extract_file_dir_path
  • parse_tuple_from_string
  • generate_hex_uuid_4
  • generate_random_file_name_with_extension
  • get_class_name
  • get_class_qualname

• Package structure has been altered.
• Drop support for Python 3.5.

Other changes:

• Update the docs.
• Switch from Python 3.6+ typing.Collection back to typing.Sequence for backward compatibility with Python 3.5.
• Support Python 3.8.
• Switch to native Python paths.
• Support Python 3.7.
• Upgrade all dependencies to the latest versions to date.

v2.0.0

v2.0.0.

• Move tests to the root.
• Pick another naming scheme for tests.
• Convert NamedTuple’s to classes and document them.
• Clean up docstrings.
• Stop indexing tests in docs.

v1.0.4

v1.0.4.

• Update HISTORY.

v1.0.3

v1.0.3.

• Fix deployment to the new PyPI.
• Mention python-humble-utils in “Open Source Projects using Hypothesis”.
• Move bumpversion configuration from setup.cfg to .bumpversion.cfg.
• Enclose notes in Note blocks.
• Remove entrypoint section from setup.py.
• Add insert utility.

v1.0.2

v1.0.2.

• Add Code Climate badge to README.

v1.0.1

v1.0.1.

• Fix README not rendered properly on PyPI.

v1.0.0

v1.0.0.

• Bump package Development Status.
• Test package deployment locally.
• Fix relative paths notice.
• Add Gitter badge.
• Fill in HISTORY.

v0.5.0

v0.5.0.

• Document python_humble_utils package.
• Introduce local requirements.
• Stop using pip-tools.
• Point out that all paths in docs are relative to the project root.
• Prevent pip-tools from injecting indirect requirements.
• Target stable docs version only.
• Fix README not rendered on PyPI.
• Ensure codecov evaluates coverage against payload files only.

v0.4.0

v0.4.0.

• Support Python 3.6.

v0.3.0

v0.3.0.

• Setup ReadTheDocs.

v0.2.0

v0.2.0.

• First release on PyPI.