Metadata-Version: 2.1
Name: search-helper
Version: 1.1.92
Summary: Cross-platform (Tk) GUI for opening predefined search URLs in a web browser
Author-email: Rainer Schwarzbach <undisclosed@example.com>
Project-URL: Homepage, https://gitlab.com/blackstream-x/search-helper
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: Source Code, https://gitlab.com/blackstream-x/search-helper.git
Keywords: gui,search,web
Classifier: Development Status :: 4 - Beta
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
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
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/)
