Metadata-Version: 2.1
Name: pygeonhole-cli
Version: 1.0.0
Summary: python cli program to organize files
Author-email: William Pol <polwilliam0@gmail.com>
License: MIT License
        
        Copyright (c) 2021 betterthan-yesterday
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/betterthan-yesterday/pygeonhole-cli.git
Keywords: typer,cli,file
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: typer ==0.3.2
Requires-Dist: colorama ==0.4.4
Requires-Dist: shellingham ==1.4.0
Requires-Dist: pytest ==6.2.4

# pygeonhole-cli

pygeonhole-cli is a convenient python package that can 
list, sort, and customize the contents of the current 
directory and export the display to a new directory 
directly from the command line.

## Usage

### To get help with command-line arguments
```
pygeonhole-cli --help
```

### Initialize pygeonhole-cli databases
```
pygeonhole-cli init
```

### Example output
```
pygeonhole-cli show -d
```
```
/Users/betterthan-yesterday/pygeonhole-cli:

#  | Name                     | Mode       | Last Modified       | Size | Ext.  |
---------------------------------------------------------------------------------
1 | tests/                   | drwxr-xr-x | 2024-01-05 18:19:26 | --   | --    |
2 | pygeonhole/              | drwxr-xr-x | 2024-01-05 18:15:43 | --   | --    |
3 | requirements.txt         | -rw-r--r-- | 2024-01-05 18:11:00 | 61   | .txt  |
4 | pyproject.toml           | -rw-r--r-- | 2024-01-07 22:07:33 | 788  | .toml |
5 | README.md                | -rw-r--r-- | 2024-01-05 18:14:04 | 54   | .md   |
6 | setup.py                 | -rw-r--r-- | 2024-01-07 22:56:50 | 1046 | .py   |
7 | LICENSE.txt              | -rw-r--r-- | 2024-01-07 22:08:00 | 1076 | .txt  |
---------------------------------------------------------------------------------
```

```
pygeonhole-cli sort Name
```
```
/Users/betterthan-yesterday/pygeonhole-cli:

#  | Name                     | Mode       | Last Modified       | Size | Ext.  |
---------------------------------------------------------------------------------
1 | pygeonhole/              | drwxr-xr-x | 2024-01-05 18:15:43 | --   | --    |
2 | tests/                   | drwxr-xr-x | 2024-01-05 18:19:26 | --   | --    |
3 | LICENSE.txt              | -rw-r--r-- | 2024-01-07 22:08:00 | 1076 | .txt  |
4 | README.md                | -rw-r--r-- | 2024-01-05 18:14:04 | 54   | .md   |
5 | pyproject.toml           | -rw-r--r-- | 2024-01-07 22:07:33 | 788  | .toml |
6 | requirements.txt         | -rw-r--r-- | 2024-01-05 18:11:00 | 61   | .txt  |
7 | setup.py                 | -rw-r--r-- | 2024-01-07 22:56:50 | 1046 | .py   |
---------------------------------------------------------------------------------
```

### Disclaimer

It is recommended that you install the package in a local
virtual env.

First, create an env. 
```sh
python3 -m venv env_for_pyhcli
```

activate that env

```sh
source env_for_pyhcli/bin/activate
```

and then pip install.

## Installation

The current stable version of pygeonhole-cli is available on PyPI and
can be installed by running `pip install pygeonhole-cli`.

Other sources:

- PyPI: 
- GitHub: 

Note: Compatibility with Windows not yet tested.

## Meta

William Pol - polwilliam0@gmail.com

Distributed under the MIT license. See LICENSE for more information.

https://github.com/bettertha-yesterday/
