<commit_before># stringer

## Purpose:
The purpose of tools is to master strings with Python.


## Required Tools:
Python
Docker
docker-compose


## Source Structure:
stringer/ is root level of the source. It is intended that the source structure will
        loosely mirror wordsum-java, it will for now be shallow and allow to
        see where the code writes.

test/ is root level of the tests for the wordsum python code.

containers/ is a directory containing the Dockerfile distribution.

## Local Setup:

### Local Setup on Ubuntu with Python and virtualenv:

1. git clone <source>

2. cd <source>

3. (if pip and virtualenv not installed) sudo apt-get install python3-pip python3-dev python-virtualenv python3.6-tk

4. virtualenv .

5. source ./bin/activate

7. pip install -r requirements.txt


## Testing:
1  cd <source>
2. pytest 

## permutations - an app to get permutations of a string.

### permutations_cli.py

A command line interface.

example command executed in virtualenv defined above: 'python permutations_cli.py --string test'


### permutations_app.py

1. setup virtualenv.

2. execute this command to launch Flast restful app: 'python ./permutations_app.py'

3. open browser and input this URL: 'http://127.0.0.1:5000/api/v1.0/permutations?string=test'

##Copyright

  Open Story License

  Story: stringer
  Writer: <NAME>&trade;
  Copyright Holders: <NAME>&trade;
  copyright &copy; 2017 <NAME>&trade;

  Permission is granted by the Copyright Holders for humans or other intelligent agents to read, write, edit, publish and critique the Story
  if the humans or intelligent agents keep this Open Story License with the Story,
  and if the Story you tell remains free,
  and if another writer writes or edits the Story then the writer's name needs to be appended to the end of the Writer list of this Open Story License.<commit_msg>Edit and clean-up the README to get closer to some state of complete.<commit_after># stringer

## Purpose:
The purpose of tools is to master strings with Python. It is also a tool to help redact sensitive information while logging
and retaining enough meta data to keep the record near the original.



## Required Tools:
Python
Docker
docker-compose


## Source Structure:
stringer/ is root level of the source. It is intended that the source structure will
        loosely mirror wordsum-java, it will for now be shallow and allow to
        see where the code writes.

test/ is root level of the tests for the wordsum python code.


## Local Setup:

### Local Setup on Ubuntu with Python and virtualenv:

1. git clone &lt;source>

2. cd &lt;source>

3. (if pip and virtualenv not installed) sudo apt-get install python-pip python-dev python-virtualenv python

4. virtualenv .

5. source ./bin/activate

7. pip install -r requirements.txt


## Testing:
1.  cd &lt;source>

2. pytest test

## permutations - an app to get permutations of a string.

### permutations_cli.py

A command line interface.

example command executed in virtualenv defined above: 'python permutations_cli.py --string test'


### permutations_app.py

1. setup virtualenv.

2. execute this command to launch Flast restful app: 'python ./permutations_app.py'

3. open browser and input this URL: 'http://127.0.0.1:5000/api/v1.0/permutations?string=test'


## Docker

1. cd <source>

2. docker-compose up

##Copyright

  Open Story License

  Story: stringer
  Writer: <NAME>&trade;
  Copyright Holders: <NAME>&trade;
  copyright &copy; 2017 <NAME>&trade;

  Permission is granted by the Copyright Holders for humans or other intelligent agents to read, write, edit, publish and critique the Story
  if the humans or intelligent agents keep this Open Story License with the Story,
  and if the Story you tell remains free,
  and if another writer writes or edits the Story then the writer's name needs to be appended to the end of the Writer list of this Open Story License.

{'fraction_non_alphanumeric': 0.07011258955987718, 'fraction_numerical': 0.015353121801432957, 'mean_word_length': 3.784577723378213, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 16, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1805443', 'n_tokens_mistral': 1170, 'n_tokens_neox': 1079, 'n_words': 545}