Metadata-Version: 2.1
Name: friendly-hash
Version: 0.1.1
Summary: A tool to rename files with human-readable hashes
Home-page: https://github.com/HTLife/friendly_hash
Author: JackyLiu
Author-email: jjkka132@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: codenamize (>=1.2.3)

# friendly_hash

A tool to rename files with human-readable hashes.

## Installation

```sh
pip3 install friendly_hash
```

add `export PATH=$PATH:~/.local/bin` to your .bashrc or .zshrc

## Usage

To show the resulting filename:
```sh
friendly_hash 2024-07-05-09-15-18.bag
# peaceful-week-2024-07-05-09-15-18.bag
```

To actually rename the file:
```sh
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**:
    ```sh
    pip3 install -r requirements.txt
    pip3 install .
    ```
2. **Run the script** to show the resulting filename:
    ```sh
    friendly_hash 2024-07-05-09-15-18.bag
    ```
3. **Run the script** to rename the file:
    ```sh
    friendly_hash -f 2024-07-05-09-15-18.bag
    ```

4. **Run tests**:
    ```sh
    python -m unittest discover
    ```
 5. **Build Package**:
    ```sh
    pip3 install setuptools wheel
    python3 setup.py sdist bdist_wheel
    pip3 install twine
    twine upload dist/*
    ```


