Metadata-Version: 2.1
Name: panopticas
Version: 0.0.7
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.

Inspired by tools like [enry](https://github.com/go-enry/go-enry) and [linguist](https://github.com/github-linguist/linguist)

Initial feaures: language detector and metadata identifiers, based on the filename extension, filename details and the shebang line. 

The official documentation can be found at [panopticas.io](https://panopticas.io)

## Installation

> pip install panopticas

## Usage

Change into the directory you want check the file types of and then run

> panopticas assess

To check a single file and get some metadata

> panopticas file FILENAME

## Development 

If you want to check out the [panopitcas repo](https://github.com/kospex/panopticas) and work on bug fixes, use the pip "editable" install to set up the _panopticas_ CLI for your shell using:
> pip install -e .



