<commit_before>* [![Master Build Status](https://travis-ci.org/d0c-s4vage/pfp.svg?branch=master)](https://travis-ci.org/d0c-s4vage/pfp) - master
* [![Develop Build Status](https://travis-ci.org/d0c-s4vage/pfp.svg?branch=develop)](https://travis-ci.org/d0c-s4vage/pfp) - develop
* [![Documentation Status](https://readthedocs.org/projects/pfp/badge/?version=latest)](https://readthedocs.org/projects/pfp/?badge=latest)

# pfp

`pfp` is a python-based interpreter for 010 template scripts.

See the main documentation on [Read the Docs](http://pfp.readthedocs.org/en/latest/)

## Tl;DR

You don't feel like going to read the docs? This should get you
started parsing something using 010 templates:

```python
import pfp

dom = pfp.parse(
	data_file="~/Desktop/image.png",
	template_file="~/Desktop/PNGTemplate.bt"
)
```
<commit_msg>added brief install info to the readme<commit_after>* [![Master Build Status](https://travis-ci.org/d0c-s4vage/pfp.svg?branch=master)](https://travis-ci.org/d0c-s4vage/pfp) - master
* [![Develop Build Status](https://travis-ci.org/d0c-s4vage/pfp.svg?branch=develop)](https://travis-ci.org/d0c-s4vage/pfp) - develop
* [![Documentation Status](https://readthedocs.org/projects/pfp/badge/?version=latest)](https://readthedocs.org/projects/pfp/?badge=latest)

# pfp

`pfp` is a python-based interpreter for 010 template scripts.

See the main documentation on [Read the Docs](http://pfp.readthedocs.org/en/latest/)

## Installation

Install pfp with

	pip install pfp

## Tl;DR

You don't feel like going to read the docs? This should get you
started parsing something using 010 templates:

```python
import pfp

dom = pfp.parse(
	data_file="~/Desktop/image.png",
	template_file="~/Desktop/PNGTemplate.bt"
)
```

{'fraction_non_alphanumeric': 0.1622554660529344, 'fraction_numerical': 0.01611047180667434, 'mean_word_length': 5.017301038062284, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1807234', 'n_tokens_mistral': 689, 'n_tokens_neox': 646, 'n_words': 125}