{"id":24479405,"url":"https://github.com/thatxliner/stacksearch","last_synced_at":"2025-04-13T14:21:20.404Z","repository":{"id":51921055,"uuid":"281838362","full_name":"ThatXliner/stacksearch","owner":"ThatXliner","description":"A python script that'll search StackOverflow and give you results you can use.","archived":false,"fork":false,"pushed_at":"2025-01-04T02:04:48.000Z","size":952,"stargazers_count":1,"open_issues_count":3,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T11:55:25.179Z","etag":null,"topics":["api","api-server","asynchronous","blessings","command-line","command-line-tool","pypi","stackexchange","stackoverflow","stacksearch","unofficial","webscraping"],"latest_commit_sha":null,"homepage":"https://stacksearch.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ThatXliner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-23T03:14:32.000Z","updated_at":"2025-01-04T02:03:06.000Z","dependencies_parsed_at":"2022-08-23T10:30:41.156Z","dependency_job_id":null,"html_url":"https://github.com/ThatXliner/stacksearch","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatXliner%2Fstacksearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatXliner%2Fstacksearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatXliner%2Fstacksearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatXliner%2Fstacksearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ThatXliner","download_url":"https://codeload.github.com/ThatXliner/stacksearch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248725097,"owners_count":21151627,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-server","asynchronous","blessings","command-line","command-line-tool","pypi","stackexchange","stackoverflow","stacksearch","unofficial","webscraping"],"created_at":"2025-01-21T10:15:53.958Z","updated_at":"2025-04-13T14:21:20.373Z","avatar_url":"https://github.com/ThatXliner.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003estacksearch 🔎\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/psf/black\"\u003e\u003cimg src=\"https://img.shields.io/badge/code%20style-black-000000.svg\" alt=\"Code style: black\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/stacksearch/\"\u003e \u003cimg alt=\"PyPI - Downloads\" src=\"https://img.shields.io/pypi/dm/stacksearch\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/stacksearch/\"\u003e\u003cimg src=\"https://img.shields.io/pypi/pyversions/stacksearch\" alt=\"PyPI - Python Version\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/stacksearch/\"\u003e\u003cimg src=\"https://img.shields.io/pypi/l/stacksearch\" alt=\"PyPI - License\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://stacksearch.readthedocs.io/en/latest/\"\u003e\u003cimg src=\"https://readthedocs.org/projects/stacksearch/badge/?version=latest\" alt=\"Documentation Status\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/ThatXliner/stacksearch/actions/workflows/python-check.yml\"\u003e\u003cimg src=\"https://github.com/ThatXliner/stacksearch/actions/workflows/python-check.yml/badge.svg\" alt=\"PythonCI\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://codecov.io/gh/ThatXliner/stacksearch\"\u003e \u003cimg src=\"https://codecov.io/gh/ThatXliner/stacksearch/branch/master/graph/badge.svg\" /\u003e \u003c/a\u003e\n\u003c/p\u003e\n\n**NOTE: STACKSEARCH IS NO LONGER ACTIVELY MAINTAINED. There will still be the occasional bug fixes and updates, but not as much.**\n\n\nStackSearch is a python library that provides an unofficial API to search various [StackExchange](https://stackexchange.com) sites such as [StackOverflow](https://stackoverflow.com).\n\nIt does *not* implement the [stack search algorithm](https://en.m.wikipedia.org/wiki/Stack_search).\n\n## Installation\n\nYou know the drill\n\n```bash\n$ pip install stacksearch\n```\n## Usage\n### CLI\n\n```bash\n$ stacksearch \"This is the query\"\n```\nor\n```bash\n$ python3 -m stacksearch \"This is the query\"\n```\n### Python API\n\n```python\n\u003e\u003e\u003e from stacksearch import sync_search\n\u003e\u003e\u003e sync_search(\"This is the query\")\n```\nor the asynchronous version\n\n```python\n\u003e\u003e\u003e import asyncio\n\u003e\u003e\u003e from stacksearch import search\n\u003e\u003e\u003e async def main():\n...    await search(\"This is the query\")\n\n\u003e\u003e\u003e asyncio.run(main())\n```\nHave fun!\n\n## Features\n\nThe benefits of this module as opposed to the other StackOverflow-searching modules is that this module provides the following:\n\n- **Reverses HTML** via [unmarkd](https://github.com/ThatXliner/unmarkd) to return useful and beautiful answers\n- The ability to return a dictionary of _ALL_ the search results found, **not just the first result** (returning from every page found still WIP)\n- The ability to return results from all [StackExchange](https://stackexchange.com/) sites\n- A **beautiful command-line interface _for humans_** via [argparse](https://docs.python.org/3/library/argparse.html) and [**Rich**](https://github.com/willmcgugan/rich)\n- An optional **asynchronous Python API**\n- The ability to **crank out raw [JSON](https://www.json.org/json-en.html) data** to use\n- Fully [type hinted](https://www.python.org/dev/peps/pep-0585/)\n\n\n## Usage Examples\n\n- For creating a text editor extension built on this package\n\n- For searching StackOverflow and/or **other StackExchange websites** without leaving the Terminal (for those [Vim](https://www.vim.org/) people)\n\n- For getting lots of answers from all StackExchange sites you know\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\nPlease feel free to contribute!\n\n## Links 📎\n\n - [GitHub](https://github.com/ThatXliner/stacksearch/tree/Stable)\n - [PyPi](https://pypi.org/project/stacksearch/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthatxliner%2Fstacksearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthatxliner%2Fstacksearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthatxliner%2Fstacksearch/lists"}