panopticas 0.0.1__tar.gz

panopticas-0.0.1/LICENSE

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

panopticas-0.0.1/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.1
+Name: panopticas
+Version: 0.0.1
+Summary: The panopticas CLI tool.
+Author-email: Peter Freiberg <peter.freiberg@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 Peter Freiberg
+        
+        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.
+        
+Project-URL: Homepage, https://panopticas.io
+Project-URL: Issues, https://github.com/kospex/panopticas/issues
+Project-URL: Repository, https://github.com/kospex/panopticas.git
+Keywords: analytics,git
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Click
+Requires-Dist: prettytable
+Requires-Dist: pathspec
+
+# panopticas
+
+Discover insights into the types of data and functions used in your code.
+
+

panopticas-0.0.1/README.md

@@ -0,0 +1,5 @@
+# panopticas
+
+Discover insights into the types of data and functions used in your code.
+
+

panopticas-0.0.1/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=70.1.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "panopticas"
+version = "0.0.1"
+description = "The panopticas CLI tool."
+authors = [
+    {name = "Peter Freiberg", email = "peter.freiberg@gmail.com"}
+]
+dependencies = [
+    "Click",
+    "prettytable",
+    "pathspec"
+]
+requires-python = ">=3.10"
+readme = "README.md"
+keywords = ["analytics", "git"]
+license = {file = "LICENSE"}
+
+classifiers = [
+      "Development Status :: 3 - Alpha",
+      "License :: OSI Approved :: MIT License",
+      "Programming Language :: Python"
+]
+
+[project.scripts]
+panopticas = "panopticas:cli"
+
+[project.urls]
+Homepage = "https://panopticas.io"
+Issues = "https://github.com/kospex/panopticas/issues"
+Repository = "https://github.com/kospex/panopticas.git"

panopticas-0.0.1/setup.cfg

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

panopticas-0.0.1/src/panopticas.egg-info/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.1
+Name: panopticas
+Version: 0.0.1
+Summary: The panopticas CLI tool.
+Author-email: Peter Freiberg <peter.freiberg@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 Peter Freiberg
+        
+        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.
+        
+Project-URL: Homepage, https://panopticas.io
+Project-URL: Issues, https://github.com/kospex/panopticas/issues
+Project-URL: Repository, https://github.com/kospex/panopticas.git
+Keywords: analytics,git
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Click
+Requires-Dist: prettytable
+Requires-Dist: pathspec
+
+# panopticas
+
+Discover insights into the types of data and functions used in your code.
+
+

panopticas-0.0.1/src/panopticas.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+src/panopticas.py
+src/panopticas_filetype.py
+src/panopticas.egg-info/PKG-INFO
+src/panopticas.egg-info/SOURCES.txt
+src/panopticas.egg-info/dependency_links.txt
+src/panopticas.egg-info/entry_points.txt
+src/panopticas.egg-info/requires.txt
+src/panopticas.egg-info/top_level.txt

panopticas-0.0.1/src/panopticas.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

panopticas-0.0.1/src/panopticas.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+panopticas = panopticas:cli

panopticas-0.0.1/src/panopticas.egg-info/requires.txt

@@ -0,0 +1,3 @@
+Click
+prettytable
+pathspec

panopticas-0.0.1/src/panopticas.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+panopticas
+panopticas_filetype

panopticas-0.0.1/src/panopticas.py

@@ -0,0 +1,66 @@
+# panopticas.py
+import click
+from prettytable import PrettyTable
+import panopticas_filetype as ft
+
+@click.group()
+def cli():
+    """Panopticas is a tool for assessing code and git repositories.
+    
+    It is designed to analysis external dependencies (e.g. URLs, cloud providers)
+
+    For documentation on how commands run `panopticas COMMAND --help`.
+
+    See also https://panopticas.io/
+    
+    """
+
+@cli.command("assess")
+#@click.option('--default', is_flag=True, default=False, help="Create the default ~/code directory.")
+@click.argument('directory', required=False, type=click.Path(exists=True))
+def assess(directory):
+    """Assess a directory."""
+    click.echo()
+    if directory:
+        click.echo(f'Assessing directory: {directory}')
+    else:
+        click.echo('Assessing current directory.')
+        directory = "."
+    files = ft.identify_files(directory)
+    click.echo(f'Found {len(files)} files.\n')
+    table = PrettyTable()
+    table.field_names = ["File", "Language"]
+    table.align["File"] = "l"
+    table.align["Language"] = "l"
+    for file in files:
+        table.add_row([file, files[file]])
+        #click.echo(files[file])
+    print(table,"\n")
+
+@cli.command("file")
+@click.argument('file', required=True,type=click.Path(exists=True))
+def identify(file):
+    """Assess a filetype."""
+    click.echo(f'\nAssessing filetype for file {file}')
+    click.echo()
+    table = PrettyTable()
+    table.field_names = ["Method", "Result"]
+    table.align["Method"] = "l"
+    table.align["Result"] = "l"
+
+    table.add_row(["File extenion", ft.get_fileext(file)])
+    table.add_row(["File type", ft.get_extension_filetype(ft.get_fileext(file))])
+    shebang = ft.check_shebang(file)
+    table.add_row(["Shebang", shebang])
+    table.add_row(["Shebang Language", ft.extract_shebang_language(shebang) if shebang else None])
+    print(table)
+    print()
+
+@cli.command("version")
+def version():
+    """Print the version of Panopticas."""
+    #click.echo(f"Panopticas version {panopticas_core.__version__}")
+    click.echo("Panopticas version 0.0.1")
+
+if __name__ == '__main__':
+    cli()

panopticas-0.0.1/src/panopticas_filetype.py

@@ -0,0 +1,153 @@
+""" File type analysis functions for Panopticas """
+import os
+import pathspec
+
+def get_fileext(file_path):
+    """ Get the file extension of a file """
+    file_type = None
+    if os.path.isfile(file_path):
+        file_type = os.path.splitext(file_path)[1]
+    if file_type:
+        return file_type
+    else:
+        return os.path.basename(file_path)
+
+def get_extension_filetype(file_path):
+    """ Get the file extension of a file, using an exact match """ 
+    filetypes = {
+            '.py': 'Python',
+            '.js': 'JavaScript',
+            '.html': 'HTML',
+            '.htm': 'HTML',
+            '.css': 'CSS',
+            '.c': 'C',
+            '.cpp': 'C++',
+            '.java': 'Java',
+            '.rb': 'Ruby',
+            '.php': 'PHP',
+            '.sh': 'Shell',
+            '.pl': 'Perl',
+            '.go': 'Go',
+            '.rs': 'Rust',
+            '.kt': 'Kotlin',
+            '.swift': 'Swift',
+            '.r': 'R',
+            '.cs': 'C#',
+            '.m': 'Objective-C',
+            '.scala': 'Scala',
+            '.sql': 'SQL',
+            '.json': 'JSON',
+            '.yaml': 'YAML',
+            '.yml': 'YAML',
+            '.toml': 'TOML',
+            '.ini': 'INI',
+            '.md': 'Markdown',
+            '.rst': 'ReStructuredText',
+            '.txt': 'Text',
+            '.csv': 'CSV',
+            '.ts': 'TypeScript',
+            '.jsx': 'JSX',
+            '.tf': 'Terraform',
+            '.tsx': 'TSX',
+            '.vue': 'Vue',
+            '.xml': 'XML',
+            '.gitignore': 'Gitignore',
+            '.dockerignore': 'Dockerignore',
+            'dockerfile': 'Dockerfile',
+            }
+
+    if file_path:
+        return filetypes.get(file_path.lower(), None)
+    else:
+        return None
+
+def check_shebang(file_path):
+    """ Check if a file has a shebang """
+    with open(file_path) as file:
+        first_line = file.readline()
+        if first_line and first_line.startswith("#!"):
+            return first_line.strip()
+        else:
+            return None
+
+def get_shebang_language(shebang):
+    """ Return the language of a shebang """
+    return None
+
+def load_gitignore_patterns(directory):
+    """
+    Load gitignore patterns from a directory
+    """
+    gitignore_path = os.path.join(directory, '.gitignore')
+
+    if os.path.exists(gitignore_path):
+
+        with open(gitignore_path, 'r') as file:
+            patterns = file.read().splitlines()
+            # Add .git to the patterns
+            patterns.append('.git')
+            # These seem to be ignore by git
+            patterns.append('.jekyll-cache')
+            patterns.append('.ruff_cache')
+            patterns.append('.DS_Store')
+
+        return pathspec.PathSpec.from_lines('gitwildmatch', patterns)
+    return None
+
+def identify_files(directory):
+    """ Identify files in a directory """
+
+    gitignore_spec = load_gitignore_patterns(directory)
+
+    file_paths = {}
+    for root, _, files in os.walk(directory):
+        for file in files:
+            full_path = os.path.join(root, file)
+            relative_path = os.path.relpath(full_path, directory)
+            if gitignore_spec and gitignore_spec.match_file(relative_path):
+                continue
+            ftype = None
+            ext = get_fileext(full_path)
+            if ext:
+                ftype = get_extension_filetype(ext)
+
+            if directory == ".":
+                full_path = full_path.removeprefix("./")
+
+            file_paths[full_path] = ftype
+
+    return file_paths
+
+
+def extract_shebang_language(shebang: str) -> str:
+    """
+    Take a string like 
+    #!/usr/bin/env python3
+    and return the language (python3)
+    """
+    parts = shebang.split()
+    # Check if the shebang string starts with '#!' and has at least two parts
+    # Check for #!/usr/bin/env python3 pattern
+    if "#!" in parts[0] and len(parts) > 1:
+
+        # Split the second part by '/' and check if it contains 'env'
+        if 'env' in parts[0]:
+            return parts[-1]  # The interpreter is the last part
+
+    # Check for 
+    # #!/usr/local/bin/perl style pattern
+    else:
+        return shebang.split('/')[-1]  # Otherwise, the interpreter is the last 
+
+    return None
+
+def get_language(file_path):
+    """ Return the language of a file """
+    return None
+
+def basename_check(file_path):
+    """
+    Return a guessed type based on the basename 
+    """
+
+    return None