semvec/pypi-packages huggingface dataset:
py2win 0.4.0
Create a stand-alone Windows distribution of a Python program
License: MIT

# py2win

[![PyPI](https://img.shields.io/pypi/v/py2win)](https://pypi.org/project/py2win)
[![CI](https://github.com/ppinard/py2win/actions/workflows/ci.yml/badge.svg)](https://github.com/ppinard/py2win/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/ppinard/py2win/branch/master/graph/badge.svg?token=CwKDVmx71Q)](https://codecov.io/gh/ppinard/py2win)

Utility to create a stand-alone distribution of a Python program, either a console or GUI program.
*py2win* uses [Python embedded distribution](https://docs.python.org/3.10/using/windows.html#embedded-distribution) and *pip* to create the stand-alone distribution.
Dependencies are therefore installed as they would be with a full Python distribution.

## Installation

You need:

* Python >= 3.6
* Microsoft Visual Studio, compatible with your current Python installation

Then simply run:

```shell
pip install py2win
```

## How to use

### As a command in `setup.py`

1. Define at least one entry point in your `setup.py`.

```python
setup(
    ...
    entry_points={
        'gui_scripts': ['sample-gui=sample.gui:main'],
        'console_scripts': ['sample-console=sample.console:main'],
    },
    ...
    )
```

2. Run the `bdist_windows` command

```shell
python setup.py --command-packages py2win bdist_windows
```

### As a separate script to create an embedded distribution

In a separate Python script (e.g. a `release.py` file in the root directory), you can define the embed process using the `EmbedPython` class and call the `run` method.

```python
from py2win.embed import EmbedPython

embed = EmbedPython('sample', '1.2.0')
embed.add_wheel(filepath_to_wheel_of_your_project)
embed.add_requirement('PyQt5')
embed.add_script(module='project.gui', method='main', executable_name='project-gui', console=False)
embed.run(destination_directory)
```

## Release notes

### 0.4.0

* Fix issue with distribution zip where zip content included extra folders
* Fix issue where compilation files/folders were not removed

### 0.3.0

* Remove deprecation warning with distutils

### 0.2.0

* Add support for arguments in console script ([PR#1](https://github.com/ppinard/py2win/pull/1>))
* Use [pathlib](https://docs.python.org/3/library/pathlib.html) for paths
* Use [pytest](https://pytest.org/en/latest/) for tests
* Use [black](https://github.com/psf/black) for formatting

### 0.1.0

* First release

## Contributors

* [@trollfred](https://github.com/trollfred)

## License

The library is provided under the MIT license.

Copyright (c) 2017 - , Philippe Pinard