[](https://results.pre-commit.ci/latest/github/jeertmans/selsearch/main)
[![Latest Release][pypi-version-badge]][pypi-version-url]
[![Python version][pypi-python-version-badge]][pypi-version-url]
# SelSearch - Internet search based on selected text
<p align="center">
<img src="https://raw.githubusercontent.com/jeertmans/selsearch/main/static/logo.png" />
</p>
SelSearch grabs text selected in any application and opens a web browser to search for.
By default, it will search on Google, but you can custimize your search to, for example, look for a DeepL translation of your text (as in the demo below).
### Installation
SelSearch can be installed using `pip`:
```
pip install selsearch
```
For more infomations about installation guidelines and known issues, see [INSTALL.md](INSTALL.md).
### Live Demo
The demo hereunder shows how you can select text, *Linux*, in a terminal, search for it in Google. Then, search for an English to French translation of some text on DeepL.
### Usage
While SeaSearch can be used in command line, it is recommended to use its background mode via:
```
selsearch run &
```
The `&` at the end will allow SelSearch to run in background.
SelSearch will continuously listen for (customizable) keyboard shortcuts and trigger various internet researches in response. For example, in the demo, Google search is mapped to `<ctrl>+<m>` and DeepL translation to `<ctrl>+<n>`.
It is also recommended to set up `selsearch run` to launch at startup. How to do that depends on your platform and is currently not handled by this project.
### Customize
SelSearch can be configured via a config file. You can generate a default one with:
```
selsearch init
```
The path will be displayed and modifications to this file will be taken into account everytime you run `selsearch` or any of its subcommands. The file will look something like this:
```toml
xsel = true # Whether to use or not XSel
exit_shortcut = "<ctrl>+<alt>+e" # Exit shortcut (optional)
[urls]
# List of urls
# You can add / remove / edit any number of lines
google = "https://www.google.com/search?q="
wordreference = "https://www.wordreference.com/enfr/"
deepl = "https://www.deepl.com/translator#en/fr/"
googlescholar = "https://scholar.google.com/scholar?q="
[shortcuts]
# List of shotcuts
# You can add / remove / edit any number of lines
"<ctrl>+0" = "google"
"<ctrl>+1" = "deepl"
"<ctrl>+2" = "wordreference"
```
You can validate your keyboard shortcuts with:
```
selsearch keys
```
Other functionnalities can be listed with:
```
selsearch --help
```
### Future Features
Here are a list of future features that I would like to add to SelSearch:
- [ ] App Icon
- [ ] Installation that defaults to launch on startup
- [x] Ability to customize keyboard shortcuts
- [ ] GUI so customize app
- [x] Use of a config folder (instead of environ variable?)
- [x] Fix keyboard shortcuts on Windows (bugs...)
- [x] Document how to use config file
### Contributing
Feel free to contribute or propose ideas using the [Issues](https://github.com/jeertmans/selsearch/issues) and [Pull requests](https://github.com/jeertmans/selsearch/pulls) tabs.
[pypi-version-badge]: https://img.shields.io/pypi/v/selsearch?label=SelSearch
[pypi-version-url]: https://pypi.org/project/selsearch/
[pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/selsearch
[github-ci-img]: https://github.com/jeertmans/pyropey/actions/workflows/CI.yml/badge.svg
[github-ci]: https://github.com/jeertmans/pyropey/actions?query=workflow%3Aci
Raw data
{
"_id": null,
"home_page": "https://github.com/jeertmans/selsearch",
"name": "selsearch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "manim,slides,plugin,manimgl",
"author": "J\u00e9rome Eertmans",
"author_email": "jeertmans@icloud.com",
"download_url": "https://files.pythonhosted.org/packages/06/80/abb61e2716b6060e3d6611b6b498b62fc36ac27bc32d925906ddf5c1ea4a/selsearch-0.4.2.tar.gz",
"platform": null,
"description": "[](https://results.pre-commit.ci/latest/github/jeertmans/selsearch/main)\n[![Latest Release][pypi-version-badge]][pypi-version-url]\n[![Python version][pypi-python-version-badge]][pypi-version-url]\n\n# SelSearch - Internet search based on selected text\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/jeertmans/selsearch/main/static/logo.png\" />\n</p>\n\nSelSearch grabs text selected in any application and opens a web browser to search for.\n\nBy default, it will search on Google, but you can custimize your search to, for example, look for a DeepL translation of your text (as in the demo below).\n\n### Installation\nSelSearch can be installed using `pip`:\n```\npip install selsearch\n```\n\nFor more infomations about installation guidelines and known issues, see [INSTALL.md](INSTALL.md).\n\n### Live Demo\n\nThe demo hereunder shows how you can select text, *Linux*, in a terminal, search for it in Google. Then, search for an English to French translation of some text on DeepL.\n\n\n\n### Usage\n\nWhile SeaSearch can be used in command line, it is recommended to use its background mode via:\n```\nselsearch run &\n```\nThe `&` at the end will allow SelSearch to run in background.\n\nSelSearch will continuously listen for (customizable) keyboard shortcuts and trigger various internet researches in response. For example, in the demo, Google search is mapped to `<ctrl>+<m>` and DeepL translation to `<ctrl>+<n>`.\n\nIt is also recommended to set up `selsearch run` to launch at startup. How to do that depends on your platform and is currently not handled by this project.\n\n### Customize\n\nSelSearch can be configured via a config file. You can generate a default one with:\n\n```\nselsearch init\n```\n\nThe path will be displayed and modifications to this file will be taken into account everytime you run `selsearch` or any of its subcommands. The file will look something like this:\n\n```toml\nxsel = true # Whether to use or not XSel\nexit_shortcut = \"<ctrl>+<alt>+e\" # Exit shortcut (optional)\n\n[urls]\n# List of urls\n# You can add / remove / edit any number of lines\ngoogle = \"https://www.google.com/search?q=\"\nwordreference = \"https://www.wordreference.com/enfr/\"\ndeepl = \"https://www.deepl.com/translator#en/fr/\"\ngooglescholar = \"https://scholar.google.com/scholar?q=\"\n\n[shortcuts]\n# List of shotcuts\n# You can add / remove / edit any number of lines\n\"<ctrl>+0\" = \"google\"\n\"<ctrl>+1\" = \"deepl\"\n\"<ctrl>+2\" = \"wordreference\"\n\n```\n\nYou can validate your keyboard shortcuts with:\n\n```\nselsearch keys\n```\n\nOther functionnalities can be listed with:\n\n```\nselsearch --help\n```\n\n### Future Features\n\nHere are a list of future features that I would like to add to SelSearch:\n\n- [ ] App Icon\n- [ ] Installation that defaults to launch on startup\n- [x] Ability to customize keyboard shortcuts\n- [ ] GUI so customize app\n- [x] Use of a config folder (instead of environ variable?)\n- [x] Fix keyboard shortcuts on Windows (bugs...)\n- [x] Document how to use config file\n\n### Contributing\n\nFeel free to contribute or propose ideas using the [Issues](https://github.com/jeertmans/selsearch/issues) and [Pull requests](https://github.com/jeertmans/selsearch/pulls) tabs.\n\n\n[pypi-version-badge]: https://img.shields.io/pypi/v/selsearch?label=SelSearch\n[pypi-version-url]: https://pypi.org/project/selsearch/\n[pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/selsearch\n[github-ci-img]: https://github.com/jeertmans/pyropey/actions/workflows/CI.yml/badge.svg\n[github-ci]: https://github.com/jeertmans/pyropey/actions?query=workflow%3Aci\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Internet search based on selected text",
"version": "0.4.2",
"project_urls": {
"Homepage": "https://github.com/jeertmans/selsearch",
"Repository": "https://github.com/jeertmans/selsearch"
},
"split_keywords": [
"manim",
"slides",
"plugin",
"manimgl"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0680abb61e2716b6060e3d6611b6b498b62fc36ac27bc32d925906ddf5c1ea4a",
"md5": "2dd556b6c0893a9a8bf06c565340f78e",
"sha256": "227948327260a4f2d5e0d2e675b97136bdcbcf9bf3eab30860604b931a7b3857"
},
"downloads": -1,
"filename": "selsearch-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "2dd556b6c0893a9a8bf06c565340f78e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 6447,
"upload_time": "2023-08-24T10:28:59",
"upload_time_iso_8601": "2023-08-24T10:28:59.356910Z",
"url": "https://files.pythonhosted.org/packages/06/80/abb61e2716b6060e3d6611b6b498b62fc36ac27bc32d925906ddf5c1ea4a/selsearch-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-24 10:28:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jeertmans",
"github_project": "selsearch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "selsearch"
}
JSON
