sum-sum

Name	sum-sum JSON
Version	0.1.0.1 JSON
	download
home_page	None
Summary	Minimal CLI tool to summarize any text locally with help of LLM!
upload_time	2025-01-15 10:00:19
maintainer	None
docs_url	None
author	Abdul Kadir
requires_python	>=3.8
license	None
keywords	local-llm ollama text-summarization
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Sumsum

A minimal CLI tool to locally summarize any text using LLM!

Built around [Ollama](https://github.com/ollama/ollama-python) and [fine-tuned version](https://huggingface.co/AKT47/Llama_3.2_3B_fine_tune_summarization) of [Llama3.2-3B-Instruct](https://huggingface.co/meta-llama/Llama-3.2-3B-Instruct)

## Installation:

```terminal
pip install sum-sum
```

## Setup:

- Run the `init` command to check dependency, download model and generate modelfile:
  ```terminal
  sumsum init
  ```

## Usage

- Use the command `run` with your text file path:
  ```terminal
  sumsum run path\to\file.txt
  ```
- you can also use the flag `--verbose` to get additional information:
  (time taken to load the model, time taken for generating new tokens,number of generated tokens etc)
  ```terminal
  sumsum run path\to\file.txt --verbose
  ```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sum-sum",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "Local-LLM, Ollama, text-summarization",
    "author": "Abdul Kadir",
    "author_email": "abdulkadir87633@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/c9/e5/34b5c8d95ee6988d613935baa03d0ca977b1a0a17c261100bdd49cd1a397/sum_sum-0.1.0.1.tar.gz",
    "platform": null,
    "description": "# Sumsum\n\nA minimal CLI tool to locally summarize any text using LLM!\n\nBuilt around [Ollama](https://github.com/ollama/ollama-python) and [fine-tuned version](https://huggingface.co/AKT47/Llama_3.2_3B_fine_tune_summarization) of [Llama3.2-3B-Instruct](https://huggingface.co/meta-llama/Llama-3.2-3B-Instruct)\n\n## Installation:\n\n```terminal\npip install sum-sum\n```\n\n## Setup:\n\n- Run the `init` command to check dependency, download model and generate modelfile:\n  ```terminal\n  sumsum init\n  ```\n\n## Usage\n\n- Use the command `run` with your text file path:\n  ```terminal\n  sumsum run path\\to\\file.txt\n  ```\n- you can also use the flag `--verbose` to get additional information:\n  (time taken to load the model, time taken for generating new tokens,number of generated tokens etc)\n  ```terminal\n  sumsum run path\\to\\file.txt --verbose\n  ```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Minimal CLI tool to summarize any text locally with help of LLM!",
    "version": "0.1.0.1",
    "project_urls": {
        "homepage": "https://github.com/AK3847/sumsum"
    },
    "split_keywords": [
        "local-llm",
        " ollama",
        " text-summarization"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "595c672740a9bea4c057fe2f4acaa98f354f706bef33eac4d41bdd0e957a19c3",
                "md5": "ec59be6b3d000518448e9afcd3219be7",
                "sha256": "1ee5222d7bf8b68a8b19fc0217f61559d938ca3348cfb74c904eaab4913a2c41"
            },
            "downloads": -1,
            "filename": "sum_sum-0.1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ec59be6b3d000518448e9afcd3219be7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 4470,
            "upload_time": "2025-01-15T10:00:17",
            "upload_time_iso_8601": "2025-01-15T10:00:17.896118Z",
            "url": "https://files.pythonhosted.org/packages/59/5c/672740a9bea4c057fe2f4acaa98f354f706bef33eac4d41bdd0e957a19c3/sum_sum-0.1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c9e534b5c8d95ee6988d613935baa03d0ca977b1a0a17c261100bdd49cd1a397",
                "md5": "77d99f7bc1ae6fe1aa5bee36282368b6",
                "sha256": "3d5781d6b5a1763e5d65b5f064f59c26da69dd5d725d33b48f52f11305883bbb"
            },
            "downloads": -1,
            "filename": "sum_sum-0.1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "77d99f7bc1ae6fe1aa5bee36282368b6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 17864,
            "upload_time": "2025-01-15T10:00:19",
            "upload_time_iso_8601": "2025-01-15T10:00:19.769165Z",
            "url": "https://files.pythonhosted.org/packages/c9/e5/34b5c8d95ee6988d613935baa03d0ca977b1a0a17c261100bdd49cd1a397/sum_sum-0.1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-15 10:00:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "AK3847",
    "github_project": "sumsum",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "sum-sum"
}