Metadata-Version: 2.3
Name: tc-pysh
Version: 0.7.0
Summary: Some utils for file manipulation scripts
Project-URL: Homepage, https://git.sr.ht/~lattay/pysh
Author-email: Théo Cavignac <theo.cavignac+dev@gmail.com>
License-Expression: BSD-3-Clause
License-File: LICENSE
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: User Interfaces
Description-Content-Type: text/markdown

# Pysh

## About

Pysh aims at providing the tools required to write in Python the script I would have written in bash before.

Python provide a more robust, and more powerful environment for scripting and makes the script easier to maintain and extend.
Pysh makes it possible to write file manipulation script just as quickly as in bash.

It should be good both for quick one-of scripts, as well as more complex reusable small programs.

## Installation

Be careful: the `pysh` name was already taken on PyPI, it is a different package, that I have nothing to do with.
My package is named `tc-pysh`

```sh
pip install tc-pysh
```

## Usage

At the center of pysh is the path facilities: `tc_pysh.AbsolutePath` and `tc_pysh.RelativePath` are objects representing locations in the file system taht are easy to manipulate and use with pysh utils, as well as with most of python standard library thanks to `os.PathLike`.

`tc_pysh.utils` provides equivalents of the commonly used commands in bash scripts such as `mv`, `cp`, `rm`, `cat`, etc.

`tc_pysh.ls` and `tc_pysh.find` provides familiar interface to the `tc_pysh.query` facilities, making it easy to browse a directory or arborescence, with tools likes sorting and filtering in the form of iterators, building on top of the standard library and the `re` standard module.

`tc_pysh.file` provides a set of functions that are related to file *content*, like `grep`, `head` and `tail`.

Here is an example of using `ls` to print the sizes of all text files of a directory.
```python
from tc_pysh import ls
from tc_pysh.file import size, human

for f in ls().name(r".*\.txt").sort():
    s = size(f) 
    s, u = human(s)

    print(str(f), s, u)
```

Commands like `ls` return a `tc_pysh.stream.Stream` object, an iterable that
is designed to chain sequence operators such as `.map` and `.filter`.

`tc_pysh.script_utils` provide convenient wrappers around the builtin
`argparse` module that helps with generating CLI in a pythonic way.

```python
from tc_pysh import ls
from tc_pysh.file import size, human
from tc_pysh.script_utils import script, optional, positional


@script(
    positional("pat", help="Pattern to math against file names."),
    optional("root", default=".", help="Where to list files."),
)
def pls(opts):
    "List files matching PAT in ROOT."
    for f in ls(opts.root).name(opts.pat).sort():
        s = size(f)
        s, u = human(s)

        print(str(f), s, u + "B")


if __name__ == "__main__":
    pls()  # automatically parses sys.argv (but you can also explicitly pass the script)
```
