Metadata-Version: 2.4
Name: linecounter-python
Version: 2.1.3
Summary: A python CLI to count lines in the project
Project-URL: Homepage, https://github.com/opplaypro/linecounter
Project-URL: Repository, https://github.com/opplaypro/linecounter.git
Project-URL: Issues, https://github.com/opplaypro/linecounter/issues
Author: opplaypro
Requires-Python: >=3.10
Requires-Dist: pathspec>=1.1.1
Requires-Dist: typer>=0.27.1
Description-Content-Type: text/markdown

# Line Counter

This is a short utility script for counting lines in each file type in a directory and subdirectories

## Installation

### Using [uv](https://docs.astral.sh/uv/) (recommended)

install globally

```bash
uv tool install linecounter-python
```

or run temporarily to check out:

```bash
uvx linecounter-python [OPTIONS]
```

## Usage

```bash
linec [OPTIONS]
```
Options:

```text
--target              -t      <directory>  Directory to analyze [default: .]
--no-default          -a                   Discard default list of globs [default: True]
--allow-hidden        -A                   Allow hidden files and directories (.)
--no-gitignore        -g                   Skip using rules from .gitignore [default: True]
--no-recurse          -r                   do not recurse into subdirectories [default: True]
--ignore              -i      <str>        Additional patterns to ignore (e.g. -i "*.log")
--install-completion                       Install completion for the current shell.
--show-completion                          Show completion for the current shell, to copy it or
                                           customize the installation.
--help                                     Show this message and exit
```
Example:

```bash
linec -gt . -i "*.lock"
```

> [!NOTE]
> `-t .` is completely useless, not specifying target defaults to `.`

produces

```text
Summary for: /home/.../linecounter-python

.py   :      255 lines
.md   :       57 lines
.toml :       17 lines
```

