codehealthkit 0.1.0__tar.gz

codehealthkit-0.1.0/LICENSE

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

codehealthkit-0.1.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: codehealthkit
+Version: 0.1.0
+Summary: Simple Python code analysis and formatting library.
+Author-email: Student Developer <student@example.com>
+License: MIT License
+        
+        Copyright (c) 2024 Student Developer
+        
+        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.
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# CodeHealthKit
+
+A simple Python library for analyzing and formatting Python code.
+
+## Installation
+
+```bash
+pip install codehealthkit
+```
+
+## Usage
+
+### Analyzer
+
+```python
+from codehealthkit.analyzer import count_lines
+print(count_lines("sample.py"))
+```
+
+### Formatter
+
+```python
+from codehealthkit.formatter import snake_to_camel
+print(snake_to_camel("student_name"))
+```
+
+## Functions
+
+### analyzer.py
+- `count_lines(file_path)` - Count total lines in a file
+- `find_todos(file_path)` - Find TODO comments
+- `find_missing_docstrings(file_path)` - Detect functions without docstrings
+- `find_duplicate_lines(file_path)` - Detect duplicate lines
+
+### formatter.py
+- `snake_to_camel(text)` - Convert snake_case to camelCase
+- `camel_to_snake(text)` - Convert camelCase to snake_case
+- `remove_trailing_whitespace(file_path)` - Remove trailing spaces
+- `find_long_lines(file_path, limit=79)` - Find lines over the limit
+
+## License
+
+MIT

codehealthkit-0.1.0/README.md

@@ -0,0 +1,43 @@
+# CodeHealthKit
+
+A simple Python library for analyzing and formatting Python code.
+
+## Installation
+
+```bash
+pip install codehealthkit
+```
+
+## Usage
+
+### Analyzer
+
+```python
+from codehealthkit.analyzer import count_lines
+print(count_lines("sample.py"))
+```
+
+### Formatter
+
+```python
+from codehealthkit.formatter import snake_to_camel
+print(snake_to_camel("student_name"))
+```
+
+## Functions
+
+### analyzer.py
+- `count_lines(file_path)` - Count total lines in a file
+- `find_todos(file_path)` - Find TODO comments
+- `find_missing_docstrings(file_path)` - Detect functions without docstrings
+- `find_duplicate_lines(file_path)` - Detect duplicate lines
+
+### formatter.py
+- `snake_to_camel(text)` - Convert snake_case to camelCase
+- `camel_to_snake(text)` - Convert camelCase to snake_case
+- `remove_trailing_whitespace(file_path)` - Remove trailing spaces
+- `find_long_lines(file_path, limit=79)` - Find lines over the limit
+
+## License
+
+MIT

codehealthkit-0.1.0/codehealthkit/__init__.py

@@ -0,0 +1,16 @@
+# CodeHealthKit - Main Package Init
+# Import all functions so users can access them directly
+
+from codehealthkit.analyzer import (
+    count_lines,
+    find_todos,
+    find_missing_docstrings,
+    find_duplicate_lines
+)
+
+from codehealthkit.formatter import (
+    snake_to_camel,
+    camel_to_snake,
+    remove_trailing_whitespace,
+    find_long_lines
+)

codehealthkit-0.1.0/codehealthkit/analyzer.py

@@ -0,0 +1,57 @@
+# analyzer.py
+# This module contains functions to analyze Python code files.
+
+def count_lines(file_path):
+    """Count the total number of lines in a file."""
+    with open(file_path, "r") as f:
+        lines = f.readlines()
+    return len(lines)
+
+
+def find_todos(file_path):
+    """Find all lines that contain TODO comments."""
+    todos = []
+    with open(file_path, "r") as f:
+        for line_number, line in enumerate(f, start=1):
+            if "TODO" in line:
+                todos.append((line_number, line.strip()))
+    return todos
+
+
+def find_missing_docstrings(file_path):
+    """Find functions that do not have a docstring."""
+    missing = []
+    with open(file_path, "r") as f:
+        lines = f.readlines()
+
+    for i, line in enumerate(lines):
+        # Check if line defines a function
+        if line.strip().startswith("def "):
+            func_name = line.strip()
+            # Check the next line for a docstring
+            next_line_index = i + 1
+            if next_line_index < len(lines):
+                next_line = lines[next_line_index].strip()
+                if not next_line.startswith('"""') and not next_line.startswith("'''"):
+                    missing.append((i + 1, func_name))
+
+    return missing
+
+
+def find_duplicate_lines(file_path):
+    """Find lines that appear more than once in a file."""
+    seen = {}
+    duplicates = []
+
+    with open(file_path, "r") as f:
+        for line_number, line in enumerate(f, start=1):
+            stripped = line.strip()
+            # Skip empty lines
+            if stripped == "":
+                continue
+            if stripped in seen:
+                duplicates.append((line_number, stripped))
+            else:
+                seen[stripped] = line_number
+
+    return duplicates

codehealthkit-0.1.0/codehealthkit/formatter.py

@@ -0,0 +1,47 @@
+# formatter.py
+# This module contains functions to format Python code and text.
+
+import re
+
+
+def snake_to_camel(text):
+    """Convert snake_case text to camelCase."""
+    # Split by underscore
+    parts = text.split("_")
+    # First word stays lowercase, rest get capitalized
+    camel = parts[0] + "".join(word.capitalize() for word in parts[1:])
+    return camel
+
+
+def camel_to_snake(text):
+    """Convert camelCase text to snake_case."""
+    # Add underscore before uppercase letters and lowercase everything
+    result = re.sub(r"([A-Z])", r"_\1", text).lower()
+    # Remove leading underscore if present
+    if result.startswith("_"):
+        result = result[1:]
+    return result
+
+
+def remove_trailing_whitespace(file_path):
+    """Remove trailing whitespace from each line in a file."""
+    with open(file_path, "r") as f:
+        lines = f.readlines()
+
+    # Strip trailing spaces from each line
+    cleaned_lines = [line.rstrip() + "\n" for line in lines]
+
+    with open(file_path, "w") as f:
+        f.writelines(cleaned_lines)
+
+    print(f"Trailing whitespace removed from: {file_path}")
+
+
+def find_long_lines(file_path, limit=79):
+    """Find lines that exceed the given character limit (default is 79)."""
+    long_lines = []
+    with open(file_path, "r") as f:
+        for line_number, line in enumerate(f, start=1):
+            if len(line.rstrip()) > limit:
+                long_lines.append((line_number, len(line.rstrip()), line.strip()))
+    return long_lines

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

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: codehealthkit
+Version: 0.1.0
+Summary: Simple Python code analysis and formatting library.
+Author-email: Student Developer <student@example.com>
+License: MIT License
+        
+        Copyright (c) 2024 Student Developer
+        
+        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.
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# CodeHealthKit
+
+A simple Python library for analyzing and formatting Python code.
+
+## Installation
+
+```bash
+pip install codehealthkit
+```
+
+## Usage
+
+### Analyzer
+
+```python
+from codehealthkit.analyzer import count_lines
+print(count_lines("sample.py"))
+```
+
+### Formatter
+
+```python
+from codehealthkit.formatter import snake_to_camel
+print(snake_to_camel("student_name"))
+```
+
+## Functions
+
+### analyzer.py
+- `count_lines(file_path)` - Count total lines in a file
+- `find_todos(file_path)` - Find TODO comments
+- `find_missing_docstrings(file_path)` - Detect functions without docstrings
+- `find_duplicate_lines(file_path)` - Detect duplicate lines
+
+### formatter.py
+- `snake_to_camel(text)` - Convert snake_case to camelCase
+- `camel_to_snake(text)` - Convert camelCase to snake_case
+- `remove_trailing_whitespace(file_path)` - Remove trailing spaces
+- `find_long_lines(file_path, limit=79)` - Find lines over the limit
+
+## License
+
+MIT

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

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+codehealthkit/__init__.py
+codehealthkit/analyzer.py
+codehealthkit/formatter.py
+codehealthkit.egg-info/PKG-INFO
+codehealthkit.egg-info/SOURCES.txt
+codehealthkit.egg-info/dependency_links.txt
+codehealthkit.egg-info/requires.txt
+codehealthkit.egg-info/top_level.txt
+tests/test_analyzer.py
+tests/test_formatter.py

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

@@ -0,0 +1 @@
+

codehealthkit-0.1.0/codehealthkit.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[dev]
+pytest

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

@@ -0,0 +1 @@
+codehealthkit

codehealthkit-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "codehealthkit"
+version = "0.1.0"
+description = "Simple Python code analysis and formatting library."
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [
+  { name = "Student Developer", email = "student@example.com" }
+]
+requires-python = ">=3.10"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["codehealthkit*"]
+
+[project.optional-dependencies]
+dev = ["pytest"]

codehealthkit-0.1.0/setup.cfg

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

codehealthkit-0.1.0/tests/test_analyzer.py

@@ -0,0 +1,59 @@
+# test_analyzer.py
+# Basic tests for analyzer.py functions
+
+import os
+import pytest
+from codehealthkit.analyzer import (
+    count_lines,
+    find_todos,
+    find_missing_docstrings,
+    find_duplicate_lines
+)
+
+# Create a temporary test file
+TEST_FILE = "test_sample.py"
+
+def setup_module():
+    """Create a sample file before tests run."""
+    content = """def hello():
+    print("hello")
+
+def greet():
+    \"\"\"This has a docstring.\"\"\"
+    pass
+
+# TODO: fix this later
+x = 1
+x = 1
+"""
+    with open(TEST_FILE, "w") as f:
+        f.write(content)
+
+
+def teardown_module():
+    """Delete the sample file after tests finish."""
+    if os.path.exists(TEST_FILE):
+        os.remove(TEST_FILE)
+
+
+def test_count_lines():
+    result = count_lines(TEST_FILE)
+    assert result > 0
+
+
+def test_find_todos():
+    result = find_todos(TEST_FILE)
+    assert len(result) >= 1
+    assert any("TODO" in line for _, line in result)
+
+
+def test_find_missing_docstrings():
+    result = find_missing_docstrings(TEST_FILE)
+    # hello() has no docstring
+    assert len(result) >= 1
+
+
+def test_find_duplicate_lines():
+    result = find_duplicate_lines(TEST_FILE)
+    # x = 1 appears twice
+    assert len(result) >= 1

codehealthkit-0.1.0/tests/test_formatter.py

@@ -0,0 +1,48 @@
+# test_formatter.py
+# Basic tests for formatter.py functions
+
+import os
+import pytest
+from codehealthkit.formatter import (
+    snake_to_camel,
+    camel_to_snake,
+    remove_trailing_whitespace,
+    find_long_lines
+)
+
+TEST_FILE = "test_format_sample.py"
+
+
+def setup_module():
+    """Create a sample file before tests run."""
+    content = "x = 1   \nthis_is_a_very_long_line_that_exceeds_the_limit_of_seventy_nine_characters_in_total = True\nclean line\n"
+    with open(TEST_FILE, "w") as f:
+        f.write(content)
+
+
+def teardown_module():
+    """Delete the sample file after tests finish."""
+    if os.path.exists(TEST_FILE):
+        os.remove(TEST_FILE)
+
+
+def test_snake_to_camel():
+    assert snake_to_camel("student_name") == "studentName"
+    assert snake_to_camel("hello_world") == "helloWorld"
+
+
+def test_camel_to_snake():
+    assert camel_to_snake("studentName") == "student_name"
+    assert camel_to_snake("helloWorld") == "hello_world"
+
+
+def test_remove_trailing_whitespace():
+    remove_trailing_whitespace(TEST_FILE)
+    with open(TEST_FILE, "r") as f:
+        for line in f:
+            assert not line.rstrip("\n").endswith(" ")
+
+
+def test_find_long_lines():
+    result = find_long_lines(TEST_FILE, limit=79)
+    assert len(result) >= 1