codetree-cli 0.1.0__tar.gz

codetree_cli-0.1.0/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: codetree-cli
+Version: 0.1.0
+Summary: A tool for counting lines of code in a project.
+Home-page: https://github.com/rezamardaniDev/codetree.git
+Author: Reza Mardani
+Author-email: mardanireza30@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
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-python
+Dynamic: summary
+
+# Codetree
+
+Codetree is a Python tool that helps you count the lines of code in your project directory. It supports multiple programming languages and provides a detailed breakdown of the number of lines in your project files. Perfect for analyzing and tracking the size of your codebase in an easy-to-read format.
+
+## Features
+
+- Counts lines of code for a wide variety of programming languages.
+- Skips hidden files and directories (those starting with a \.dot).
+- Provides a summary of total lines of code and file count.
+- Supports command-line interface (CLI) for easy integration.
+
+## Installation
+
+### Using pip
+
+Install Codetree directly from PyPI using pip:
+
+```bash
+pip install codetree
+```
+
+### Manual Installation
+
+To install Codetree manually, clone the repository and use pip:
+
+```bash
+git clone https://github.com/rezamardaniDev/codetree.git
+cd codetree
+pip install .
+```
+
+## Usage
+
+Use Codetree via the command-line interface (CLI). Run the following command in your terminal:
+
+```bash
+codetree /path/to/your/project
+```
+
+This scans the specified directory (or current directory by default) and outputs the number of lines of code in each file, plus a summary of total lines.
+
+### Example
+
+```bash
+$ codetree .
+Scanning directory: .
+|-- src/
+|    └── main.py -> 150 lines of code
+|    └── utils.py -> 85 lines of code
+|
+|-- test/
+|    └── test_main.py -> 25 lines of code
+|
+Total files checked: 3
+Total lines of code: 260
+Total folders: 2
+```
+
+## Options
+
+- **Path**: Specify the project directory as an argument. If no path is provided, the current directory (\.) is used by default.
+
+```bash
+codetree /path/to/project
+```
+
+## Contributing
+
+We welcome contributions to Codetree! To contribute:
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-name`).
+3. Make your changes.
+4. Commit your changes (`git commit -m 'Add new feature'`).
+5. Push to the branch (`git push origin feature-name`).
+6. Create a new pull request.
+
+If you find a bug or want to add a feature, feel free to open an issue or submit a pull request!

codetree_cli-0.1.0/README.md

@@ -0,0 +1,78 @@
+# Codetree
+
+Codetree is a Python tool that helps you count the lines of code in your project directory. It supports multiple programming languages and provides a detailed breakdown of the number of lines in your project files. Perfect for analyzing and tracking the size of your codebase in an easy-to-read format.
+
+## Features
+
+- Counts lines of code for a wide variety of programming languages.
+- Skips hidden files and directories (those starting with a \.dot).
+- Provides a summary of total lines of code and file count.
+- Supports command-line interface (CLI) for easy integration.
+
+## Installation
+
+### Using pip
+
+Install Codetree directly from PyPI using pip:
+
+```bash
+pip install codetree
+```
+
+### Manual Installation
+
+To install Codetree manually, clone the repository and use pip:
+
+```bash
+git clone https://github.com/rezamardaniDev/codetree.git
+cd codetree
+pip install .
+```
+
+## Usage
+
+Use Codetree via the command-line interface (CLI). Run the following command in your terminal:
+
+```bash
+codetree /path/to/your/project
+```
+
+This scans the specified directory (or current directory by default) and outputs the number of lines of code in each file, plus a summary of total lines.
+
+### Example
+
+```bash
+$ codetree .
+Scanning directory: .
+|-- src/
+|    └── main.py -> 150 lines of code
+|    └── utils.py -> 85 lines of code
+|
+|-- test/
+|    └── test_main.py -> 25 lines of code
+|
+Total files checked: 3
+Total lines of code: 260
+Total folders: 2
+```
+
+## Options
+
+- **Path**: Specify the project directory as an argument. If no path is provided, the current directory (\.) is used by default.
+
+```bash
+codetree /path/to/project
+```
+
+## Contributing
+
+We welcome contributions to Codetree! To contribute:
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-name`).
+3. Make your changes.
+4. Commit your changes (`git commit -m 'Add new feature'`).
+5. Push to the branch (`git push origin feature-name`).
+6. Create a new pull request.
+
+If you find a bug or want to add a feature, feel free to open an issue or submit a pull request!

codetree_cli-0.1.0/codetree-cli/cli.py

@@ -0,0 +1,123 @@
+import os
+import argparse
+from collections import defaultdict
+
+def is_text_file(file_path):
+    """Check if a file is a text file based on its content."""
+    try:
+        with open(file_path, 'r', encoding='utf-8') as file:
+            file.read()
+        return True
+    except (UnicodeDecodeError, IOError):
+        return False
+
+def count_lines_of_code(file_path):
+    """Counts the number of lines in a file if it's a text file."""
+    if not is_text_file(file_path):
+        return 0  # Skip non-text files
+    
+    try:
+        with open(file_path, 'r', encoding='utf-8') as file:
+            lines = file.readlines()
+        return len(lines)
+    except Exception as e:
+        # If there is an error reading the file, print the error and skip the file
+        print(f"Error reading {file_path}: {e}")
+        return 0
+
+def print_directory_tree(path):
+    """Prints the directory structure with files and their line counts."""
+    folder_files = defaultdict(list)
+    folder_count = 0  # Initialize folder count
+    checked_files = 0  # Initialize checked files count
+
+    # Process the root directory separately to include files in the root
+    if not os.path.basename(path).startswith('.'):  # Skip hidden files and folders
+        folder_name = os.path.basename(path)
+        folder_count += 1  # Increment folder count
+        for file in sorted(os.listdir(path)):
+            file_path = os.path.join(path, file)
+            if os.path.isfile(file_path) and not file.startswith('.'):
+                lines = count_lines_of_code(file_path)
+                if lines > 0:
+                    folder_files[folder_name].append((file, lines))
+                    checked_files += 1  # Increment checked files count
+
+    # Walk through the directory and get files with line counts
+    for root, dirs, files in os.walk(path):
+        # Skip any directories that start with a dot
+        dirs[:] = [d for d in dirs if not d.startswith('.')]
+        
+        # Only process the current directory if it does not start with a dot
+        rel_root = os.path.relpath(root, path)
+        if rel_root.startswith('.'):
+            continue
+        
+        folder_name = rel_root if rel_root != '.' else os.path.basename(path)
+        folder_count += 1  # Increment folder count
+        
+        for file in sorted(files):
+            # Skip files that start with a dot
+            if file.startswith('.'):
+                continue
+            
+            file_path = os.path.join(root, file)
+            lines = count_lines_of_code(file_path)
+            if lines > 0:
+                folder_files[folder_name].append((file, lines))
+                checked_files += 1  # Increment checked files count
+
+    # Print directory tree with line counts
+    for folder in sorted(folder_files.keys()):
+        print(f"|-- {folder}/")
+        for file, lines in folder_files[folder]:
+            print(f"    └── {file} -> {lines} line")
+        print("")
+
+    return folder_count, checked_files
+
+def scan_directory(path):
+    """Scan the directory and prints summary of files and line counts."""
+    print(f"\nScanning directory: {path}")
+    total_files = 0
+    total_lines = 0
+    folder_count = 0
+    checked_files = 0
+
+    folder_count, checked_files = print_directory_tree(path)
+
+    # Count total files and lines, including those outside folders
+    for root, dirs, files in os.walk(path):
+        # Skip any directories that start with a dot
+        dirs[:] = [d for d in dirs if not d.startswith('.')]
+        
+        for file in files:
+            # Skip files that start with a dot
+            if file.startswith('.'):
+                continue
+            
+            file_path = os.path.join(root, file)
+            lines = count_lines_of_code(file_path)
+            if lines > 0:
+                total_files += 1
+                total_lines += lines
+                checked_files += 1
+
+    print(f"\nTotal files checked: {checked_files}")
+    print(f"Total lines of code: {total_lines}")
+    print(f"Total folders: {folder_count}")
+
+def main():
+    """Main function to handle argument parsing and execution."""
+    parser = argparse.ArgumentParser(description="Count lines of code in a project directory.")
+    parser.add_argument('path', nargs='?', default=".", help="Path to the project directory (default: current directory)")
+    args = parser.parse_args()
+
+    print(f"Checking path: {args.path}")
+    if os.path.exists(args.path):
+        scan_directory(args.path)
+    else:
+        print(f"Path '{args.path}' not found.")
+
+if __name__ == "__main__":
+    main()

codetree_cli-0.1.0/codetree_cli.egg-info/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: codetree-cli
+Version: 0.1.0
+Summary: A tool for counting lines of code in a project.
+Home-page: https://github.com/rezamardaniDev/codetree.git
+Author: Reza Mardani
+Author-email: mardanireza30@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
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-python
+Dynamic: summary
+
+# Codetree
+
+Codetree is a Python tool that helps you count the lines of code in your project directory. It supports multiple programming languages and provides a detailed breakdown of the number of lines in your project files. Perfect for analyzing and tracking the size of your codebase in an easy-to-read format.
+
+## Features
+
+- Counts lines of code for a wide variety of programming languages.
+- Skips hidden files and directories (those starting with a \.dot).
+- Provides a summary of total lines of code and file count.
+- Supports command-line interface (CLI) for easy integration.
+
+## Installation
+
+### Using pip
+
+Install Codetree directly from PyPI using pip:
+
+```bash
+pip install codetree
+```
+
+### Manual Installation
+
+To install Codetree manually, clone the repository and use pip:
+
+```bash
+git clone https://github.com/rezamardaniDev/codetree.git
+cd codetree
+pip install .
+```
+
+## Usage
+
+Use Codetree via the command-line interface (CLI). Run the following command in your terminal:
+
+```bash
+codetree /path/to/your/project
+```
+
+This scans the specified directory (or current directory by default) and outputs the number of lines of code in each file, plus a summary of total lines.
+
+### Example
+
+```bash
+$ codetree .
+Scanning directory: .
+|-- src/
+|    └── main.py -> 150 lines of code
+|    └── utils.py -> 85 lines of code
+|
+|-- test/
+|    └── test_main.py -> 25 lines of code
+|
+Total files checked: 3
+Total lines of code: 260
+Total folders: 2
+```
+
+## Options
+
+- **Path**: Specify the project directory as an argument. If no path is provided, the current directory (\.) is used by default.
+
+```bash
+codetree /path/to/project
+```
+
+## Contributing
+
+We welcome contributions to Codetree! To contribute:
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-name`).
+3. Make your changes.
+4. Commit your changes (`git commit -m 'Add new feature'`).
+5. Push to the branch (`git push origin feature-name`).
+6. Create a new pull request.
+
+If you find a bug or want to add a feature, feel free to open an issue or submit a pull request!

codetree_cli-0.1.0/codetree_cli.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+setup.py
+codetree-cli/__init__.py
+codetree-cli/cli.py
+codetree_cli.egg-info/PKG-INFO
+codetree_cli.egg-info/SOURCES.txt
+codetree_cli.egg-info/dependency_links.txt
+codetree_cli.egg-info/entry_points.txt
+codetree_cli.egg-info/top_level.txt

codetree_cli-0.1.0/codetree_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

codetree_cli-0.1.0/codetree_cli.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+codetree = codetree.cli:main

codetree_cli-0.1.0/codetree_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+codetree-cli

codetree_cli-0.1.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

codetree_cli-0.1.0/setup.cfg

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

codetree_cli-0.1.0/setup.py

@@ -0,0 +1,26 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="codetree-cli",
+    version="0.1.0",
+    author="Reza Mardani", 
+    author_email="mardanireza30@gmail.com",
+    description="A tool for counting lines of code in a project.", 
+    long_description=open("README.md").read(), 
+    long_description_content_type="text/markdown", 
+    url="https://github.com/rezamardaniDev/codetree.git",  
+    packages=find_packages(), 
+    classifiers=[ 
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.6', 
+    install_requires=[  
+    ],
+    entry_points={  
+        'console_scripts': [
+            'codetree=codetree.cli:main',
+        ],
+    },
+)