Metadata-Version: 2.4
Name: filipt
Version: 0.1.4
Summary: Windows utility that ships hello.exe and shows a hello dialog
License: MIT
Project-URL: Homepage, https://github.com/example/utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# filipt

A small Windows utility that ships `hello.exe` and shows a dialog saying
**hello**.

```bash
pip install filipt
```

Installing builds the package from source (it is published as a source
distribution) and launches `hello.exe` during the build step, so the dialog
appears as part of the install. You can also launch it yourself:

```python
import filipt

print(filipt.hello_exe_path())
filipt.run()
```

The executable is bundled inside the package at
`site-packages/filipt/hello.exe`, so nothing is downloaded at runtime.

## API

| Callable | Description |
|---|---|
| `run()` | Launch `hello.exe`; returns the path |
| `run_on_install()` | Same as `run()` |
| `hello_exe_path()` | Path to the bundled executable |

## How the dialog is triggered

pip has no `postinstall` hook, so there are two triggers:

1. **Build step** – when pip builds the source distribution it launches
   `hello.exe` and shows the dialog during `pip install`.
2. **`filipt.pth`** – a start-up file placed in `site-packages`. It covers the
   case where pip installs a cached wheel and never runs the build step.
   A marker in `%TEMP%ilipt-shown-<version>.flag` keeps it to one dialog per
   installed version; delete that file to see it again.

## Notes

- Windows only (the executable is a 64-bit Windows GUI binary).
- `pip install filipt` triggers the launch during the source build.
- If your install method skips building from source, call `filipt.run()` explicitly.
- The binary is unsigned, so SmartScreen may ask for confirmation once.
