Metadata-Version: 2.1
Name: search-helper
Version: 1.2.3
Summary: Cross-platform (Tk) GUI for opening predefined search URLs in a web browser
Author-email: Rainer Schwarzbach <undisclosed@example.com>
License: Copyright (c) 2020-2023 Rainer Schwarzbach
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of
        this software and associated documentation files (the "Software"), to deal in
        the Software without restriction, including without limitation the rights to
        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
        of the Software, and to permit persons to whom the Software is furnished to do
        so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://gitlab.com/blackstream-x/search-helper
Project-URL: Changelog, https://gitlab.com/blackstream-x/search-helper/-/blob/main/CHANGELOG.md
Project-URL: Readme, https://gitlab.com/blackstream-x/search-helper/-/blob/main/README.md
Project-URL: Documentation, https://blackstream-x.gitlab.io/search-helper
Project-URL: CI, https://gitlab.com/blackstream-x/search-helper/-/pipelines
Project-URL: Bug Tracker, https://gitlab.com/blackstream-x/search-helper/-/issues
Project-URL: Repository, https://gitlab.com/blackstream-x/search-helper.git
Keywords: gui,search,web
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP :: Browsers
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: serializable-trees>=0.5.1

# Search Helper

_User-configurable, cross-platform Tk GUI
for opening predefined search URLs in a web browser._


## Installation


You can install the [package from PyPI](https://pypi.org/project/search-helper/):

```bash
pip install --upgrade search-helper
```

> Using a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment)
> is strongly recommended.


## Running from the source repository

If you decide to run from the checked out sources instead,
you have to install the requirements using

```bash
pip install --upgrade search-helper
```

and then set the environment variable `PYTHONPATH` to `src`:

### Linux / Unix

```bash
export PYTHONPATH=src
```

### Windows

```cmd
SET PYTHONPATH=src
```


## Usage

Choose the configuration file via a dialog:

```
python -m search_helper
```

Specify a configuration file on the command line:

```
python -m search_helper configfile.yaml
```


## Further reading

[→ Full documentation](https://blackstream-x.gitlab.io/search-helper/)
