Metadata-Version: 2.1
Name: file-grouper
Version: 0.1.2
Summary: Group file based on file name pattern defined by regex.
Home-page: https://github.com/anselmwang/file_grouper
Author: Yu Wang
Author-email: anselmwang@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: click (>=8.0.4,<9.0.0)
Project-URL: Repository, https://github.com/anselmwang/file_grouper
Description-Content-Type: text/markdown

# Usage

I use this script to group beestar maths worksheet

```
pipx install file-grouper
group_file --no-dryrun --key_regex "(grade_03_.*)_\d\d" --group_no 1 --dst_root grade3_group\ grade3\*
```

# Setup Dev Environment

First clone this repo then change to the repo directory.

Then run following command:
```sh
pip install poetry
poetry install   # Create virtual environement, install all dependencies for the project
poetry shell     # activate the virtual environment
pre-commit install    # to ensure automatically formatting, linting, type checking and testing before every commit
```

If you want to run unit test manually, just activate virtual environment and run:
```sh
pytest
```
