<commit_before># DEVELOPMENT BINNACLE

## Tools used

* [Python](https://www.python.org/): 3.7
* [Pipenv](https://github.com/pypa/pipenv): 2018.11.26
* [Twine](https://github.com/pypa/twine/) : 3.1.1

Run develoment local:
```bash
    cd sync-py
    pipenv install --dev -e .
    pipenv graph
```

Create **dist files**: 
```bash
pipenv run python setup.py sdist bdist_wheel
```

Check **dist files**: 
```bash
twine check dist/*
```

Publish on test.pypi.org: 
```bash
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
```

> Don't forget to increase the version

## TODO

- [ ] Add version one version manager (https://packaging.python.org/guides/single-sourcing-package-version/#single-sourcing-the-version)
- [ ] Add properly test


###  External documentation used

1. [Distributing packages Official documentation](https://packaging.python.org/guides/distributing-packages-using-setuptools/#uploading-your-project-to-pypi)

1. [Real python blog - How to Publish an Open-Source Python Package to PyPI](https://realpython.com/pypi-publish-python-package/)

1. [Pipenv documentation](https://github.com/pypa/pipenv)

1. [Getting Started With Testing in Python](https://realpython.com/python-testing/)
<commit_msg>How to test and publish documentation info added<commit_after># DEVELOPMENT BINNACLE

## Tools used

* [Python](https://www.python.org/): 3.7
* [Pipenv](https://github.com/pypa/pipenv): 2018.11.26
* [Twine](https://github.com/pypa/twine/) : 3.1.1

## Set up local development 
Run development local:
```bash
    cd sync-py
    pipenv install --dev -e .
    pipenv graph
```

## Publish on test.pypi.org

1.Create **dist files**: 
```bash
pipenv run python setup.py sdist bdist_wheel
```

2.Check **dist files**: 
```bash
twine check dist/*
```

3.Publish on test.pypi.org: 
```bash
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
```

> Don't forget to increase the version

## Test from test.pypi.org
1. Pipfile
```python
[[source]]
name = "test"
url = "https://test.pypi.org/simple"
verify_ssl = true

[dev-packages]
python-dotenv = "*"

[packages]
sync-py = {index = "test",version = "*"}

# .
# .
# .
# Omitted
```

2. Install and update`pipenv install --dev` and `pipenv update`

3. Run `pipevn run python path-to/test.py`

## TODO

- [ ] Add version one version manager (https://packaging.python.org/guides/single-sourcing-package-version/#single-sourcing-the-version)
- [ ] Add properly test


###  External documentation used

1. [Distributing packages Official documentation](https://packaging.python.org/guides/distributing-packages-using-setuptools/#uploading-your-project-to-pypi)

1. [Real python blog - How to Publish an Open-Source Python Package to PyPI](https://realpython.com/pypi-publish-python-package/)

1. [Pipenv documentation](https://github.com/pypa/pipenv)

1. [Getting Started With Testing in Python](https://realpython.com/python-testing/)

{'fraction_non_alphanumeric': 0.1613013698630137, 'fraction_numerical': 0.0136986301369863, 'mean_word_length': 3.984641638225256, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 19, 'lorem ipsum': 0, 'www.': 2, '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': '563918', 'n_tokens_mistral': 1082, 'n_tokens_neox': 1004, 'n_words': 241}