Add initial implementation of extliner package with README, CLI, and line counting functionality

Author: codeperfectplus

README.md

@@ -0,0 +1,100 @@
+Here’s a clean and informative `README.md` for your package **`extliner`**:
+
+---
+
+## 📦 extliner
+
+**extliner** is a lightweight Python package that counts lines in files (with and without empty lines) grouped by file extension — perfect for analyzing codebases or text-heavy directories.
+
+---
+
+### 🚀 Features
+
+* 📂 Recursive directory traversal
+* 🔍 Counts:
+
+  * Total lines **with** whitespace
+  * Total lines **excluding** empty lines
+* 🎯 Extension-based grouping (`.py`, `.txt`, `NO_EXT`, etc.)
+* 🚫 Option to **ignore specific file extensions**
+* 📊 Beautiful **tabulated output**
+* 🧩 Easily extensible class-based design
+* 🧪 CLI support
+
+---
+
+### 📥 Installation
+
+```bash
+pip install extliner
+```
+
+(Or if using locally during development:)
+
+```bash
+git clone https://github.com/extliner/extliner.git
+cd extliner
+pip install -e .
+```
+
+---
+
+### 🧑‍💻 Usage
+
+#### ✅ CLI
+
+```bash
+extliner -d <directory_path> --ignore .log .json
+```
+
+#### Example
+
+```bash
+extliner -d ./myproject --ignore .md .log
+```
+
+#### Output
+
+```
++------------+---------------+-------------------+--------------+
+| Extension  | With Spaces   | Without Spaces    | % of Total   |
++------------+---------------+-------------------+--------------+
+| .py        | 320           | 280               | 65.31%       |
+| .txt       | 170           | 150               | 34.69%       |
++------------+---------------+-------------------+--------------+
+```
+
+---
+
+### 🧱 Python API
+
+```python
+from linecountx.main import LineCounter
+from pathlib import Path
+
+counter = LineCounter(ignore_extensions=[".log", ".json"])
+result = counter.count_lines(Path("./your_directory"))
+
+print(counter.to_json(result))
+```
+
+---
+
+### ⚙️ Options
+
+| Flag       | Description                  | Example                   |
+| ---------- | ---------------------------- | ------------------------- |
+| `-d`       | Directory to scan (required) | `-d ./src`                |
+| `--ignore` | File extensions to ignore    | `--ignore .log .md .json` |
+
+
+### 📄 License
+
+MIT License
+
+---
+
+### 👨‍💻 Author
+
+Made with ❤️ by [Deepak Raj](https://github.com/extliner)
+

extliner/__init__.py

@@ -0,0 +1,56 @@
+import argparse
+from pathlib import Path
+from tabulate import tabulate
+
+from extliner.main import LineCounter
+
+def main():
+    parser = argparse.ArgumentParser(description="Count lines in files by extension.")
+    parser.add_argument(
+        "-d", "--directory", type=Path, required=True,
+        help="Directory to count lines in."
+    )
+    parser.add_argument(
+        "--ignore", nargs="*", default=[],
+        help="List of file extensions to ignore (e.g., .log .json)"
+    )
+
+    args = parser.parse_args()
+
+    if not args.directory.is_dir():
+        print(f"Error: {args.directory} is not a valid directory")
+        return
+
+    counter = LineCounter(ignore_extensions=args.ignore)
+    result = counter.count_lines(args.directory)
+
+    # Remove extensions with 0 lines
+    result = {
+        ext: counts for ext, counts in result.items()
+        if counts["with_spaces"] > 0 or counts["without_spaces"] > 0
+    }
+
+    # Sort result by extension
+    result = dict(sorted(result.items()))
+
+    total_with_spaces = sum(counts["with_spaces"] for counts in result.values())
+    
+    # sort the result by the number of lines with spaces
+    result = dict(sorted(result.items(), key=lambda item: item[1]["with_spaces"], reverse=True))
+
+    table = []
+    for ext, counts in result.items():
+        with_spaces = counts["with_spaces"]
+        without_spaces = counts["without_spaces"]
+        percent = (with_spaces / total_with_spaces * 100) if total_with_spaces else 0
+        table.append([ext, with_spaces, without_spaces, f"{percent:.2f}%"])
+
+    print(tabulate(
+        table,
+        headers=["Extension", "With Spaces", "Without Spaces", "% of Total"],
+        tablefmt="grid"
+    ))
+
+
+if __name__ == "__main__":
+    main()

extliner/cli.py

@@ -0,0 +1,47 @@
+import os
+import json
+from pathlib import Path
+from collections import defaultdict
+from typing import Dict, List, Optional
+
+
+class LineCounter:
+    def __init__(self, ignore_extensions: Optional[List[str]] = None):
+        self.ignore_extensions = set(ignore_extensions or [])
+        self.with_spaces: Dict[str, int] = defaultdict(int)
+        self.without_spaces: Dict[str, int] = defaultdict(int)
+
+    def count_lines(self, directory: Path) -> Dict[str, Dict[str, int]]:
+        directory = Path(directory)
+        if not directory.is_dir():
+            raise ValueError(f"{directory} is not a valid directory")
+
+        for root, _, files in os.walk(directory):
+            for file in files:
+                filepath = Path(root) / file
+                ext = filepath.suffix or "NO_EXT"
+
+                if ext in self.ignore_extensions:
+                    continue
+
+                try:
+                    with open(filepath, "r", encoding="utf-8", errors="ignore") as f:
+                        lines = f.readlines()
+                        self.with_spaces[ext] += len(lines)
+                        self.without_spaces[ext] += sum(1 for line in lines if line.strip())
+                except Exception as e:
+                    print(f"Error reading {filepath}: {e}")
+
+        return self._build_result()
+
+    def _build_result(self) -> Dict[str, Dict[str, int]]:
+        return {
+            ext: {
+                "with_spaces": self.with_spaces[ext],
+                "without_spaces": self.without_spaces[ext],
+            }
+            for ext in sorted(set(self.with_spaces) | set(self.without_spaces))
+        }
+
+    def to_json(self, data: Dict) -> str:
+        return json.dumps(data, indent=2)

extliner/main.py

@@ -0,0 +1 @@
+tabulate==0.9.0

requirements.txt

@@ -0,0 +1,36 @@
+#!/bin/bash
+check_command() {
+    if [ ! -x "$(command -v $1)" ]; then
+        echo "$1 is not installed"
+        pip install $1
+        exit 1
+    fi
+}
+
+check_directory() {
+    if [ ! -d "$1" ]; then
+        echo "$1 is not found"
+        exit 1
+    fi
+}
+
+check_file() {
+    if [ ! -f "$1" ]; then
+        echo "$1 is not found"
+        exit 1
+    fi
+}
+
+# check if the git is installed
+check_command git
+check_command flake8
+check_command twine
+check_file setup.py
+python setup.py sdist bdist_wheel
+check_directory dist
+python -m twine upload dist/* --verbose
+
+rm -rf dist
+rm -rf build
+rm -rf *.egg-info
+find . -name "*.pyc" -exec rm -rf {}\;

scripts/release.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+check_command() {
+    if [ ! -x "$(command -v $1)" ]; then
+        echo "$1 is not installed"
+        pip install $1
+        exit 1
+    fi
+}
+
+check_directory() {
+    if [ ! -d "$1" ]; then
+        echo "$1 is not found"
+        exit 1
+    fi
+}
+
+check_file() {
+    if [ ! -f "$1" ]; then
+        echo "$1 is not found"
+        exit 1
+    fi
+}
+
+# check if the git is installed
+check_command git
+check_command flake8
+check_command twine
+check_file ./setup.py
+python setup.py sdist bdist_wheel
+check_directory dist
+python -m twine upload --repository testpypi dist/*
+
+rm -rf dist
+rm -rf build
+rm -rf *.egg-info
+find . -name "*.pyc" -exec rm -rf {}\;

scripts/test_release.sh

@@ -0,0 +1,54 @@
+from setuptools import setup, find_packages
+
+# Read the long description from README.md
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+# Read the list of requirements from requirements.txt
+with open("requirements.txt", "r", encoding="utf-8") as fh:
+    requirements = fh.read().splitlines()
+
+setup(
+    name="extliner",
+    version="0.0.1",
+    author="Deepak Raj",
+    author_email="[email protected]",
+    description=(
+        "A simple command-line tool to count lines in files by extension, "
+    ),
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/codeperfectplus/extliner",
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=requirements,
+    python_requires=">=3.6",
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Intended Audience :: Developers"
+    ],
+    project_urls={
+        "Documentation": "https://extliner.readthedocs.io/en/latest/",
+        "Source": "https://github.com/codeperfectplus/extliner",
+        "Tracker": "https://github.com/codeperfectplus/extliner/issues"
+    },
+    entry_points={
+        "console_scripts": [
+            "extliner=extliner.cli:main",  # Update path if needed
+        ],
+    },
+    keywords=[
+        "line count",
+        "file analysis",
+        "command line tool",
+        "file extension",
+        "python",
+        "CLI",
+        "file processing",
+        
+    ],
+    license="MIT",
+)

setup.py

@@ -0,0 +1,16 @@
+import os
+from extliner.main import LineCounter
+from pprint import pprint
+
+# print("Testing line counting functionality...")
+# result = count_lines(os.getcwd())
+# print("Result:")
+# pprint(result)
+
+counter = LineCounter(ignore_extensions=[".py"])
+result = counter.count_lines(os.getcwd())
+print("JSON Output:")
+
+print(counter.to_json(result))
+
+print(type(counter.to_json(result)))