Metadata-Version: 2.4
Name: panopticas
Version: 0.0.16
Summary: The panopticas file type and CLI tool.
Author-email: Peter Freiberg <peter.freiberg@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://panopticas.io
Project-URL: Issues, https://github.com/kospex/panopticas/issues
Project-URL: Repository, https://github.com/kospex/panopticas
Keywords: analytics,git
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Click>=8.3.1
Requires-Dist: prettytable>=3.17.0
Requires-Dist: pathspec>=0.12.1
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Dynamic: license-file

# 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)

Features: language detector and metadata identifiers, based on the filename extension, filename details and the shebang line. Detects build configurations, dependency manifests, CI pipeline files, and binary file types.

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

## Installation

```bash
pip install panopticas
```

## Usage

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

```bash
panopticas assess
```

To check a single file and get some metadata:

```bash
panopticas file FILENAME
```

To find URLs in files:

```bash
panopticas urls /path/to/directory
```

## Development

If you want to check out the [panopticas repo](https://github.com/kospex/panopticas) and work on bug fixes, use the pip "editable" install:

```bash
pip install -e .
```

### Running Tests

```bash
pytest -v
```

### Building and Publishing

```bash
python -m build
twine upload dist/*
```

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for version history.

## License

MIT
