pseek 1.0.1__tar.gz

pseek-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Arian
+
+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.

pseek-1.0.1/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.2
+Name: pseek
+Version: 1.0.1
+Summary: Pseek is a Python library to search files, folders, and text
+Home-page: https://github.com/ArianN8610/pysearch
+Author: Arian
+Author-email: ariannasiri86@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click==8.1.8
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Pseek
+
+## Overview
+
+A powerful command-line tool for searching files, directories, and content inside files efficiently. The tool supports searching by name, content, extensions, and more with advanced filtering options.
+
+## Features
+
+* **Search in file & folder names**
+* **Search inside file contents**
+* **Highlight matches** in terminal output
+* **Optimized for speed** with ThreadPoolExecutor
+* **Cross-platform** (Linux, macOS, Windows)
+
+## Installation
+
+### **1️⃣ Install via `pip` (Recommended)**
+
+```sh
+pip install pseek
+```
+
+### **2️⃣ Install from source**
+
+```sh
+git clone https://github.com/ArianN8610/pysearch.git
+cd pseek
+pip install click==8.1.8
+```
+
+## Usage
+
+Run the command with a search query:
+```sh
+pseek <query> [options]
+```
+
+## Examples
+
+### Search for a keyword in file & folder names
+
+```sh
+pseek "my_keyword" --path /path/to/search --file --directory
+```
+
+### Search inside file contents
+
+```sh
+pseek "error" --path /var/logs --content
+```
+
+### Search only in specific file types
+
+```sh
+pseek "TODO" --path ./projects --ext py --ext txt
+```
+
+### Search by regex
+
+```sh
+pseek "error\d+" --regex
+```
+
+## Command Options
+
+| Option                     | Description                                                  |
+|----------------------------|--------------------------------------------------------------|
+| `--path`                   | Base directory to search in (default: current directory `.`) |
+| `--file`                   | Search only in file names                                    |
+| `--directory`              | Search only in directory names                               |
+| `--content`                | Search inside file contents                                  |
+| `--ext`                    | Filter by file extension (e.g., `.txt`, `.log`)              |
+| `--case-sensitive`         | Make the search case-sensitive                               |
+| `--regex`                  | Use regular expression for searching                         |
+| `--include`, `--exclude`   | Limit search results to specific set of directories or files |
+| `--word`                   | Match the whole word only                                    |
+| `--max-size`, `--min-size` | Specify maximum and minimum sizes for files and directories  |
+| `--full-path`              | Display full path of files and directories                   |

pseek-1.0.1/README.md

@@ -0,0 +1,78 @@
+# Pseek
+
+## Overview
+
+A powerful command-line tool for searching files, directories, and content inside files efficiently. The tool supports searching by name, content, extensions, and more with advanced filtering options.
+
+## Features
+
+* **Search in file & folder names**
+* **Search inside file contents**
+* **Highlight matches** in terminal output
+* **Optimized for speed** with ThreadPoolExecutor
+* **Cross-platform** (Linux, macOS, Windows)
+
+## Installation
+
+### **1️⃣ Install via `pip` (Recommended)**
+
+```sh
+pip install pseek
+```
+
+### **2️⃣ Install from source**
+
+```sh
+git clone https://github.com/ArianN8610/pysearch.git
+cd pseek
+pip install click==8.1.8
+```
+
+## Usage
+
+Run the command with a search query:
+```sh
+pseek <query> [options]
+```
+
+## Examples
+
+### Search for a keyword in file & folder names
+
+```sh
+pseek "my_keyword" --path /path/to/search --file --directory
+```
+
+### Search inside file contents
+
+```sh
+pseek "error" --path /var/logs --content
+```
+
+### Search only in specific file types
+
+```sh
+pseek "TODO" --path ./projects --ext py --ext txt
+```
+
+### Search by regex
+
+```sh
+pseek "error\d+" --regex
+```
+
+## Command Options
+
+| Option                     | Description                                                  |
+|----------------------------|--------------------------------------------------------------|
+| `--path`                   | Base directory to search in (default: current directory `.`) |
+| `--file`                   | Search only in file names                                    |
+| `--directory`              | Search only in directory names                               |
+| `--content`                | Search inside file contents                                  |
+| `--ext`                    | Filter by file extension (e.g., `.txt`, `.log`)              |
+| `--case-sensitive`         | Make the search case-sensitive                               |
+| `--regex`                  | Use regular expression for searching                         |
+| `--include`, `--exclude`   | Limit search results to specific set of directories or files |
+| `--word`                   | Match the whole word only                                    |
+| `--max-size`, `--min-size` | Specify maximum and minimum sizes for files and directories  |
+| `--full-path`              | Display full path of files and directories                   |

pseek-1.0.1/pseek/cli.py

@@ -0,0 +1,65 @@
+import re
+import click
+
+from .utils import display_results
+from .searcher import search_in_names, search_in_file_contents
+
+
+@click.command()
+@click.argument('query')
+@click.option('-p', '--path', type=click.Path(exists=True, file_okay=False, dir_okay=True), default='.',
+              show_default=True, help='Base directory to search in.')
+@click.option('-f', '--file', is_flag=True, help='Search only in file names.')
+@click.option('-d', '--directory', is_flag=True, help='Search only in directory names.')
+@click.option('-c', '--content', is_flag=True, help='Search inside file contents.')
+@click.option('-C', '--case-sensitive', is_flag=True, help='Make the search case-sensitive.')
+@click.option('--ext', multiple=True, type=click.STRING,
+              help='Filter results by file extension. Example: --ext py --ext js')
+@click.option('--regex', is_flag=True, help='Use regular expression for searching.')
+@click.option('-i', '--include', type=click.Path(exists=True, file_okay=True, dir_okay=True),
+              multiple=True, help='Directories or files that contain search results.')
+@click.option('-e', '--exclude', type=click.Path(exists=True, file_okay=True, dir_okay=True),
+              multiple=True, help='Directories or files not included in search results.')
+@click.option('--word', is_flag=True, help='Search for results that match the whole word.')
+@click.option('--max-size', type=click.FLOAT, help='Maximum size directory or file can have (MB)')
+@click.option('--min-size', type=click.FLOAT, help='Minimum size directory or file can have (MB)')
+@click.option('--full-path', is_flag=True, help='Display complete paths of files and directories.')
+def search(query, path, file, directory, content, case_sensitive, ext, regex, include, exclude, word,
+           max_size, min_size, full_path):
+    """Search for files, directories, and content based on the query."""
+
+    if regex:
+        try:
+            re.compile(query)  # Ensure valid regex
+        except re.error:
+            click.echo(click.style('Invalid regex pattern: ', fg='red') + query)
+            return
+
+    # Enable all search types if none are explicitly selected
+    if not any([file, directory, content]):
+        file = directory = content = True
+
+    results = []
+
+    if file:
+        filename_results = search_in_names(path, query, case_sensitive, regex, include, exclude, word, max_size,
+                                           min_size, full_path, ext)
+        display_results(filename_results, 'Files', 'file')
+        results.extend(filename_results)
+    if directory and not ext:
+        dir_results = search_in_names(path, query, case_sensitive, regex, include, exclude, word, max_size, min_size,
+                                      full_path, is_file=False)
+        display_results(dir_results, 'Directories', 'directory')
+        results.extend(dir_results)
+    if content:
+        content_results = search_in_file_contents(path, query, case_sensitive, ext, regex, include, exclude, word,
+                                                  max_size, min_size, full_path)
+        display_results(content_results, 'Contents', 'content')
+        results.extend(content_results)
+
+    message = f'\nTotal results: {len(results)}' if results else 'No results found'
+    click.echo(click.style(message, fg='red'))  # Display total of results
+
+
+if __name__ == "__main__":
+    search()

pseek-1.0.1/pseek/searcher.py

@@ -0,0 +1,106 @@
+import re
+import click
+from pathlib import Path
+from concurrent.futures import ThreadPoolExecutor
+
+from .utils import highlight_matches, safe_is_file
+
+
+def search_in_names(base_path, query, case_sensitive, regex, include, exclude, whole_word, max_size, min_size,
+                    full_path, ext=tuple(), is_file=True):
+    """Search for file and folder names"""
+    base_path = Path(base_path)
+    matches = []
+
+    if not regex:
+        query = re.escape(query)  # If regex is disabled, convert query to plain text
+
+    if whole_word:
+        query = rf'\b{query}\b'  # Ensure search for whole words
+
+    flags = 0 if case_sensitive else re.IGNORECASE  # Adjust case sensitivity
+
+    # Convert include and exclude paths to `Path`
+    include_paths = {Path(p).resolve() for p in include}
+    exclude_paths = {Path(p).resolve() for p in exclude}
+
+    for p in base_path.rglob('*'):
+        p_resolved = p.resolve()  # Actual file or folder path
+        p_size_mb = p_resolved.stat().st_size / 1_048_576  # Convert to MB
+
+        if (
+                # If include is given, at least one of them must be present in the name
+                (include and not any(p_resolved.is_relative_to(inc) for inc in include_paths))
+                # If exclude is given, none should be in the name
+                or (exclude and any(p_resolved.is_relative_to(exc) for exc in exclude_paths))
+                # Prevent unnecessary continuation in case of type mismatch
+                or (is_file and ext and p.suffix[1:] not in ext)
+                # Check file or directory size
+                or (max_size and p_size_mb > max_size)
+                or (min_size and p_size_mb < min_size)
+        ):
+            continue
+
+        if re.search(query, p.name, flags) and ((is_file and p.is_file()) or (not is_file and p.is_dir())):
+            # Specify the found part
+            highlighted_name = re.sub(query, lambda m: click.style(m.group(), fg='green'), p.name, flags=flags)
+            p_parent = p_resolved.parent if full_path else p.parent  # Get full path if full_path is True
+            matches.append(f'{p_parent}\\{highlighted_name}')
+
+    return matches
+
+
+def search_in_file_contents(base_path, query, case_sensitive, ext, regex, include, exclude, whole_word,
+                            max_size, min_size, full_path):
+    """Search inside file contents"""
+    base_path = Path(base_path)
+    matches = []
+
+    if not regex:
+        query = re.escape(query)
+
+    if whole_word:
+        query = rf'\b{query}\b'
+
+    flags = 0 if case_sensitive else re.IGNORECASE
+
+    include_paths = {Path(p).resolve() for p in include}
+    exclude_paths = {Path(p).resolve() for p in exclude}
+
+    def process_file(file_path):
+        """Processes a single file and searches for the query inside its content."""
+        p_resolved = file_path.resolve()
+        p_size_mb = p_resolved.stat().st_size / 1_048_576
+
+        if (
+                # Filter by include/exclude directories
+                (include and not any(p_resolved.is_relative_to(inc) for inc in include_paths))
+                or (exclude and any(p_resolved.is_relative_to(exc) for exc in exclude_paths))
+                # Filter by extension
+                or (ext and p_resolved.suffix[1:] not in ext)
+                # Filter by file size
+                or (max_size and p_size_mb > max_size)
+                or (min_size and p_size_mb < min_size)
+        ):
+            return
+
+        try:
+            for num, line in enumerate(p_resolved.read_text(encoding='utf-8', errors='ignore').splitlines(), 1):
+                line = line.strip()
+
+                if re.search(query, line, flags):
+                    highlighted_snippet, count_query = highlight_matches(line, query, case_sensitive, regex, whole_word)
+                    file_path = p_resolved if full_path else file_path
+                    matches.append(
+                        click.style(file_path, fg='cyan')
+                        + click.style(f' (Line {num}) (Repeated {count_query} time(s)): ', fg='magenta')
+                        + highlighted_snippet
+                    )
+        except Exception:
+            return  # Ignore unreadable files
+
+    # Use multi-threading for faster processing
+    with ThreadPoolExecutor() as executor:
+        executor.map(process_file, (file for file in base_path.rglob('*') if safe_is_file(file)))
+
+    return matches

pseek-1.0.1/pseek/utils.py

@@ -0,0 +1,66 @@
+import re
+import click
+
+
+def highlight_matches(line, query, case_sensitive, regex, whole_word, context=20):
+    """Highlight matches and truncate long lines with proper handling"""
+
+    flags = 0 if case_sensitive else re.IGNORECASE
+
+    if not regex and not whole_word:
+        query = re.escape(query)  # If regex is disabled, use escape to search for regular text
+
+    # Find all matches
+    matches = list(re.finditer(query, line, flags))
+
+    if not matches:
+        return None  # If there is no match, return None
+
+    start_positions = [max(0, m.start() - context) for m in matches]  # 20 characters before
+    end_positions = [min(len(line), m.end() + context) for m in matches]  # 20 characters after
+
+    # Combine sections close together to avoid repetition
+    merged_snippets = []
+    current_start, current_end = start_positions[0], end_positions[0]
+
+    for i in range(1, len(matches)):
+        if start_positions[i] <= current_end:  # If the next section is close, combine them
+            current_end = max(current_end, end_positions[i])
+        else:
+            merged_snippets.append((current_start, current_end))
+            current_start, current_end = start_positions[i], end_positions[i]
+
+    merged_snippets.append((current_start, current_end))  # Add the last section
+
+    result = []
+    for start, end in merged_snippets:
+        snippet = line[start:end]
+        snippet = re.sub(query, lambda m: click.style(m.group(), fg='green'), snippet, flags=flags)
+        result.append(snippet)
+
+    final_output = ' ... '.join(result)  # If there are multiple results, put `...` between them
+
+    # Add `...` at the beginning and end if needed
+    if merged_snippets[0][0] > 0:
+        final_output = '...' + final_output
+    if merged_snippets[-1][1] < len(line):
+        final_output += '...'
+
+    return final_output, len(matches)  # Count the number of repetitions
+
+
+def safe_is_file(file):
+    """Check if a file is accessible and return True/False."""
+    try:
+        return file.is_file()
+    except OSError:
+        return False  # Ignore files that cannot be accessed
+
+
+def display_results(results, title, result_name):
+    """Display search results"""
+    if results:
+        click.echo(click.style(f'\n{title}:\n', fg='yellow'))
+        for result in results:
+            click.echo(result)
+        click.echo(click.style(f'\n{len(results)} result(s) found for {result_name}', fg='blue'))

pseek-1.0.1/pseek.egg-info/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.2
+Name: pseek
+Version: 1.0.1
+Summary: Pseek is a Python library to search files, folders, and text
+Home-page: https://github.com/ArianN8610/pysearch
+Author: Arian
+Author-email: ariannasiri86@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click==8.1.8
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Pseek
+
+## Overview
+
+A powerful command-line tool for searching files, directories, and content inside files efficiently. The tool supports searching by name, content, extensions, and more with advanced filtering options.
+
+## Features
+
+* **Search in file & folder names**
+* **Search inside file contents**
+* **Highlight matches** in terminal output
+* **Optimized for speed** with ThreadPoolExecutor
+* **Cross-platform** (Linux, macOS, Windows)
+
+## Installation
+
+### **1️⃣ Install via `pip` (Recommended)**
+
+```sh
+pip install pseek
+```
+
+### **2️⃣ Install from source**
+
+```sh
+git clone https://github.com/ArianN8610/pysearch.git
+cd pseek
+pip install click==8.1.8
+```
+
+## Usage
+
+Run the command with a search query:
+```sh
+pseek <query> [options]
+```
+
+## Examples
+
+### Search for a keyword in file & folder names
+
+```sh
+pseek "my_keyword" --path /path/to/search --file --directory
+```
+
+### Search inside file contents
+
+```sh
+pseek "error" --path /var/logs --content
+```
+
+### Search only in specific file types
+
+```sh
+pseek "TODO" --path ./projects --ext py --ext txt
+```
+
+### Search by regex
+
+```sh
+pseek "error\d+" --regex
+```
+
+## Command Options
+
+| Option                     | Description                                                  |
+|----------------------------|--------------------------------------------------------------|
+| `--path`                   | Base directory to search in (default: current directory `.`) |
+| `--file`                   | Search only in file names                                    |
+| `--directory`              | Search only in directory names                               |
+| `--content`                | Search inside file contents                                  |
+| `--ext`                    | Filter by file extension (e.g., `.txt`, `.log`)              |
+| `--case-sensitive`         | Make the search case-sensitive                               |
+| `--regex`                  | Use regular expression for searching                         |
+| `--include`, `--exclude`   | Limit search results to specific set of directories or files |
+| `--word`                   | Match the whole word only                                    |
+| `--max-size`, `--min-size` | Specify maximum and minimum sizes for files and directories  |
+| `--full-path`              | Display full path of files and directories                   |

pseek-1.0.1/pseek.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+setup.py
+pseek/__init__.py
+pseek/cli.py
+pseek/searcher.py
+pseek/utils.py
+pseek.egg-info/PKG-INFO
+pseek.egg-info/SOURCES.txt
+pseek.egg-info/dependency_links.txt
+pseek.egg-info/entry_points.txt
+pseek.egg-info/requires.txt
+pseek.egg-info/top_level.txt

pseek-1.0.1/pseek.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pseek-1.0.1/pseek.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pseek = pseek.cli:search

pseek-1.0.1/pseek.egg-info/requires.txt

@@ -0,0 +1 @@
+click==8.1.8

pseek-1.0.1/pseek.egg-info/top_level.txt

@@ -0,0 +1 @@
+pseek

pseek-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pseek-1.0.1/setup.py

@@ -0,0 +1,24 @@
+from setuptools import setup, find_packages
+
+with open("README.md", encoding="utf-8") as f:
+    long_description = f.read()
+
+setup(
+    name="pseek",
+    version="1.0.1",
+    author="Arian",
+    author_email="ariannasiri86@gmail.com",
+    description="Pseek is a Python library to search files, folders, and text",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/ArianN8610/pysearch",
+    packages=find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.6",
+    install_requires=["click==8.1.8"],
+    entry_points={"console_scripts": ["pseek=pseek.cli:search"]}
+)