<commit_before># PythonSkeleton

## Usage

This section explains how to use this project.

Run the main entry point program.

```sh
PYTHONPATH=. bin/ps
```


## Setup

This section explains how to install and uninstall this project.

Install the project.

```sh
pip3 install git+https://git@github.com/FunTimeCoding/python-skeleton.git#egg=python-skeleton
```

Uninstall the project.

```sh
pip3 uninstall python-skeleton
```


## Development

This section explains commands to help the development of this project.

Install the project from a local clone.

```sh
./development-setup.sh
```

Run tests, style check and metrics.

```sh
./run-tests.sh
./run-style-check.sh
./run-metrics.sh
```

Build the project.

```sh
./build.sh
```


## Skeleton details

* The `tests` directory is not called `test` because there is a package with that name.
* Dashes in project names become underscores in Python.<commit_msg>add a line of explanation to the skeleton section of the readme<commit_after># PythonSkeleton

## Usage

This section explains how to use this project.

Run the main entry point program.

```sh
PYTHONPATH=. bin/ps
```


## Setup

This section explains how to install and uninstall this project.

Install the project.

```sh
pip3 install git+https://git@github.com/FunTimeCoding/python-skeleton.git#egg=python-skeleton
```

Uninstall the project.

```sh
pip3 uninstall python-skeleton
```


## Development

This section explains commands to help the development of this project.

Install the project from a local clone.

```sh
./development-setup.sh
```

Run tests, style check and metrics.

```sh
./run-tests.sh
./run-style-check.sh
./run-metrics.sh
```

Build the project.

```sh
./build.sh
```


## Skeleton

This section explains details of the project skeleton.

- The `tests` directory is not called `test` because there is a package with that name.
- Dashes in project names become underscores in Python.
{'fraction_non_alphanumeric': 0.1077003121748179, 'fraction_numerical': 0.002081165452653486, 'mean_word_length': 3.9689922480620154, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, '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': '1233248', 'n_tokens_mistral': 620, 'n_tokens_neox': 569, 'n_words': 229}