Metadata-Version: 2.1
Name: auto-files-identifier
Version: 0.0.3
Summary: Automatic File Identifier
Home-page: UNKNOWN
Author: Supratik Chatterjee
Author-email: supratikdevm96@gmail.com
License: MIT
Project-URL: Source, https://github.com/supratikchatterjee16/afi
Project-URL: Issues, https://github.com/supratikchatterjee16/afi/issues
Keywords: extensions signatures filehandling file identification
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE

# Automatic File Identifier

A simple program written to identify a file using the extension or using file signatures.  
Failing to do either, implies that the file might be a text file with no signature or extension.

It is not intended to be a final solution that finds everything about a file.  
i.e. the purpose is to provide mimes for popular identifiable formats.

It is to be integrated with another project called Advanced Pattern Finder.

## Installing

```shell
pip install auto-files-identifier
```

Or, clone the repository at https://github.com/supratikchatterjee16/afi, and

```shell
pip install .
```

## Using

There is a signature downloader, which is tailored to download and store information found on [File Signatures](https://filesignatures.net/).  
This creates a python file named signatures.py, which needs to be in the same folder as the program.  
The program imports this and makes use of it.


```python
import afi
list_mime_tuples = afi.identify(path_to_resource)#can be a folder or file path

# The above gives you a list of tuples which contain the mimes for each identified file
# It identifies using both extension and signatures
```

However, there is a second way of making use of it as well.

```shell
afi /path/to/file/or/folder
```

## Author

Supratik Chatterjee

## Issues

There are some(quite a lot I suspect) popular file extensions and signatures missing.  
I believe there are way more than 650 extensions.

Should one find something missing, kindly do let me know.

## Downloading

```bash
mkdir afi
cd ./afi
git init
git remote add origin https://github.com/supratikchatterjee16/afi.git
git pull origin master
pip install .
```


