# pyformatters_summarizer
[![license](https://img.shields.io/github/license/oterrier/pyformatters_summarizer)](https://github.com/oterrier/pyformatters_summarizer/blob/master/LICENSE)
[![tests](https://github.com/oterrier/pyformatters_summarizer/workflows/tests/badge.svg)](https://github.com/oterrier/pyformatters_summarizer/actions?query=workflow%3Atests)
[![codecov](https://img.shields.io/codecov/c/github/oterrier/pyformatters_summarizer)](https://codecov.io/gh/oterrier/pyformatters_summarizer)
[![docs](https://img.shields.io/readthedocs/pyformatters_summarizer)](https://pyformatters_summarizer.readthedocs.io)
[![version](https://img.shields.io/pypi/v/pyformatters_summarizer)](https://pypi.org/project/pyformatters_summarizer/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyformatters_summarizer)](https://pypi.org/project/pyformatters_summarizer/)
Formatter based on Facebook's Summarizer
## Installation
You can simply `pip install pyformatters_summarizer`.
## Developing
### Pre-requesites
You will need to install `flit` (for building the package) and `tox` (for orchestrating testing and documentation building):
```
python3 -m pip install flit tox
```
Clone the repository:
```
git clone https://github.com/oterrier/pyformatters_summarizer
```
### Running the test suite
You can run the full test suite against all supported versions of Python (3.8) with:
```
tox
```
### Building the documentation
You can build the HTML documentation with:
```
tox -e docs
```
The built documentation is available at `docs/_build/index.html.
Raw data
{
"_id": null,
"home_page": "https://github.com/oterrier/pyformatters_summarizer/",
"name": "pyformatters-summarizer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Olivier Terrier",
"author_email": "olivier.terrier@kairntech.com",
"download_url": "https://files.pythonhosted.org/packages/7f/f7/431e47eef25c5f2c0055b96e71026149af8606a742d059c745a14195410e/pyformatters_summarizer-0.5.210.tar.gz",
"platform": null,
"description": "# pyformatters_summarizer\n\n[![license](https://img.shields.io/github/license/oterrier/pyformatters_summarizer)](https://github.com/oterrier/pyformatters_summarizer/blob/master/LICENSE)\n[![tests](https://github.com/oterrier/pyformatters_summarizer/workflows/tests/badge.svg)](https://github.com/oterrier/pyformatters_summarizer/actions?query=workflow%3Atests)\n[![codecov](https://img.shields.io/codecov/c/github/oterrier/pyformatters_summarizer)](https://codecov.io/gh/oterrier/pyformatters_summarizer)\n[![docs](https://img.shields.io/readthedocs/pyformatters_summarizer)](https://pyformatters_summarizer.readthedocs.io)\n[![version](https://img.shields.io/pypi/v/pyformatters_summarizer)](https://pypi.org/project/pyformatters_summarizer/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyformatters_summarizer)](https://pypi.org/project/pyformatters_summarizer/)\n\nFormatter based on Facebook's Summarizer\n\n## Installation\n\nYou can simply `pip install pyformatters_summarizer`.\n\n## Developing\n\n### Pre-requesites\n\nYou will need to install `flit` (for building the package) and `tox` (for orchestrating testing and documentation building):\n\n```\npython3 -m pip install flit tox\n```\n\nClone the repository:\n\n```\ngit clone https://github.com/oterrier/pyformatters_summarizer\n```\n\n### Running the test suite\n\nYou can run the full test suite against all supported versions of Python (3.8) with:\n\n```\ntox\n```\n\n### Building the documentation\n\nYou can build the HTML documentation with:\n\n```\ntox -e docs\n```\n\nThe built documentation is available at `docs/_build/index.html.\n",
"bugtrack_url": null,
"license": null,
"summary": "Formatter based on Huggingface transformers summarization pipeline",
"version": "0.5.210",
"project_urls": {
"Homepage": "https://github.com/oterrier/pyformatters_summarizer/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "09bb56dfee1f6906256e3cca0cc55371dbe3e3b4e60a73f92b6d558efa8b78c5",
"md5": "49c67fae998522fd2b0c2382534cd88c",
"sha256": "0344cd3f9bf1c517b89a3abd8d1e724cee43566cff107d2784551d4346555b2f"
},
"downloads": -1,
"filename": "pyformatters_summarizer-0.5.210-py3-none-any.whl",
"has_sig": false,
"md5_digest": "49c67fae998522fd2b0c2382534cd88c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6532,
"upload_time": "2024-01-23T12:59:12",
"upload_time_iso_8601": "2024-01-23T12:59:12.923621Z",
"url": "https://files.pythonhosted.org/packages/09/bb/56dfee1f6906256e3cca0cc55371dbe3e3b4e60a73f92b6d558efa8b78c5/pyformatters_summarizer-0.5.210-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7ff7431e47eef25c5f2c0055b96e71026149af8606a742d059c745a14195410e",
"md5": "f83c5404adf03f9474e52950b0aa9b0c",
"sha256": "d6261db19fe5bf890618230ff9a1b67b83b96523a2fbb7ed26ddd8fe8efc2f79"
},
"downloads": -1,
"filename": "pyformatters_summarizer-0.5.210.tar.gz",
"has_sig": false,
"md5_digest": "f83c5404adf03f9474e52950b0aa9b0c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 374849,
"upload_time": "2024-01-23T12:59:15",
"upload_time_iso_8601": "2024-01-23T12:59:15.734321Z",
"url": "https://files.pythonhosted.org/packages/7f/f7/431e47eef25c5f2c0055b96e71026149af8606a742d059c745a14195410e/pyformatters_summarizer-0.5.210.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-23 12:59:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oterrier",
"github_project": "pyformatters_summarizer",
"github_not_found": true,
"lcname": "pyformatters-summarizer"
}