<commit_before>## Synopsis

This package is a lightweight set of profiling utilities for Neo4J databases.
This is intended to quickly help users derive the rough structure and
population of a new Neo4J database.

## Quick Start

**Clone the repo**: `git clone https://github.com/moxious/neoprofiler.git`

**Package the application**:  `mvn package`

Note that packaging includes the creation of a runnable "One JAR" which includes all necessary dependencies.

**Run from the command line**: 
`java -jar target/neoprofiler-0.13.one-jar.jar -db path_to_db -format html -output db_profile_report.html`

The argument given to the application should be the path to a directory containing a neo4j database.

## Usage

```
usage: NeoProfiler
 -db <db>           Path to directory where neo4j database is located
 -format <format>   Output format: valid values are json, markdown, or
                    html
 -output <output>   Name of output file to write; program will print to
                    console if not specified.<commit_msg>updated version<commit_after>## Synopsis

This package is a lightweight set of profiling utilities for Neo4J databases.
This is intended to quickly help users derive the rough structure and
population of a new Neo4J database.

## Quick Start

**Clone the repo**: `git clone https://github.com/moxious/neoprofiler.git`

**Package the application**:  `mvn package`

Note that packaging includes the creation of a runnable "One JAR" which includes all necessary dependencies.

**Run from the command line**: 
`java -jar target/neoprofiler-0.14.one-jar.jar -db path_to_db -format html -output db_profile_report.html`

The argument given to the application should be the path to a directory containing a neo4j database.

## Usage

```
usage: NeoProfiler
 -db <db>           Path to directory where neo4j database is located
 -format <format>   Output format: valid values are json, markdown, or
                    html
 -output <output>   Name of output file to write; program will print to
                    console if not specified.
{'fraction_non_alphanumeric': 0.06983511154219205, 'fraction_numerical': 0.006789524733268671, 'mean_word_length': 3.5241228070175437, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 2, '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': '3120358', 'n_tokens_mistral': 571, 'n_tokens_neox': 544, 'n_words': 264}