<commit_before>op-return-ninja README
==================



Running the Web Interface
---------------

- cd <directory containing this file>

- $VENV/bin/python setup.py develop

# this step may be required again in the future but for the moment on_block.py isn't
# run with pserve so a db is manually specified in the code.
# - $VENV/bin/initialize_op-return-ninja_db development.ini

- $VENV/bin/pserve development.ini


Configuring Bitcoin Core
---------------

opreturn-ninja requires bitcoin core running in the background for the historical API.

#### Sample bitcoin.conf

```
#testnet=1
rpcuser=rpcuser
rpcpassword=g3wlPdnxVvIhUq1F5XdbQroIwIMfpmWPzAUKez0Su01zAIH72NeMQDV5q47Ui4O
server=1
#prune=1000
disablewallet=1
blocknotify="cd /home/user/prod/opreturn-ninja/ && python -m opreturnninja.on_block --block-hash %s"
```<commit_msg>rename readme<commit_after>op-return-ninja README
==================



Running the Web Interface
---------------

```
- cd <directory containing this file>

- $VENV/bin/python setup.py develop

# this step may be required again in the future but for the moment on_block.py isn't
# run with pserve so a db is manually specified in the code.
# - $VENV/bin/initialize_op-return-ninja_db development.ini

- $VENV/bin/pserve development.ini
```


Configuring Bitcoin Core
---------------

opreturn-ninja requires bitcoin core running in the background for the historical API.

#### Sample bitcoin.conf

```
#testnet=1
rpcuser=rpcuser
rpcpassword=g3wlPdnxVvIhUq1F5XdbQroIwIMfpmWPzAUKez0Su01zAIH72NeMQDV5q47Ui4O
server=1
#prune=1000
disablewallet=1
blocknotify="cd /home/user/prod/opreturn-ninja/ && python -m opreturnninja.on_block --block-hash %s"
```
{'fraction_non_alphanumeric': 0.1423487544483986, 'fraction_numerical': 0.022538552787663108, 'mean_word_length': 4.112121212121212, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, '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': '2669993', 'n_tokens_mistral': 609, 'n_tokens_neox': 563, 'n_words': 151}