friendly-hash 0.1.0

A tool to rename files with human-readable hashes

friendly_hash

A tool to rename files with human-readable hashes.

Installation

pip3 install friendly_hash

Usage

To show the resulting filename:

friendly_hash 2024-07-05-09-15-18.bag
# peaceful-week-2024-07-05-09-15-18.bag

To actually rename the file:

friendly_hash -f 2024-07-05-09-15-18.bag
# peaceful-week-2024-07-05-09-15-18.bag

For Developer

1. Install the package:

   pip3 install -r requirements.txt
   pip3 install .
   

2. Run the script to show the resulting filename:

   friendly_hash 2024-07-05-09-15-18.bag
   

3. Run the script to rename the file:

   friendly_hash -f 2024-07-05-09-15-18.bag
   

4. Run tests:

   python -m unittest discover
   

5. Build Package:

   pip3 install setuptools wheel
   python setup.py sdist bdist_wheel
   pip3 install twine
   twine upload dist/*