Metadata-Version: 2.1
Name: wheelfile
Version: 0.0.9
Summary: API for inspecting and creating .whl files
Description-Content-Type: text/markdown
Keywords: wheel,packaging,pip,build,distutils
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Archiving :: Packaging
Classifier: Topic :: System :: Software Distribution
Classifier: Topic :: Utilities
Author: Błażej Michalik
Home-page: https://github.com/MrMino/wheelfile
Requires-Python: >=3.9
Requires-Dist: packaging >= 20.8



<table style="border: none">
<tr style="border: none">
<td style="border: none">
<h1 style='border-bottom-style: none' align="center"> Wheelfile 🔪🧀</h1>

This library aims to make it dead simple to create a format-compliant [.whl
file (wheel)](https://pythonwheels.com/). It provides an API comparable to
[zipfile](https://docs.python.org/3/library/zipfile.html). Use this if you wish
to inspect or create wheels in your code.

For a quick look, see the example on the right, which packages the wheelfile
module itself into a wheel 🤸.

#### What's the difference between this and [wheel](https://pypi.org/project/wheel/)?

"Wheel" tries to provide a reference implementation for the standard. It is used
by setuptools and has its own CLI, but no stable API. The goal of Wheelfile is
to provide a simple API.

Wheelfile does not depend on Wheel.

## Acknowledgements

Thanks to [Paul Moore](https://github.com/pfmoore) for providing
[his gist](https://gist.github.com/pfmoore/20f3654ca33f8b14f0fcb6dfa1a6b469)
of basic metadata parsing logic, which helped to avoid many foolish mistakes
in the initial implementation.

</td>
<td style="border: none">

<br/>

<a href="https://pypi.org/project/wheelfile/#history">
<img src="https://img.shields.io/pypi/v/wheelfile?style=for-the-badge"/>
</a>
<a href="https://wheelfile.readthedocs.io/en/latest/">
<img src="https://readthedocs.org/projects/wheelfile/badge/?version=latest&style=for-the-badge"/>
</a>

<br/>
<br/>

```
pip install wheelfile
```

```py
from wheelfile import WheelFile, __version__

spec = {
    'distname': 'wheelfile',
    'version': __version__
}

requirements = [
    'packaging >= 20.8',
]

with WheelFile(mode='w', **spec) as wf:
    wf.metadata.requires_dists = requirements
    wf.write('./wheelfile.py')

# 🧀
```
<br/>
<b> More examples:
    <a href="https://wheelfile.readthedocs.io/en/latest/examples/buildscript.html"> buildscript </a> |
    <a href="https://wheelfile.readthedocs.io/en/latest/examples/pep-517-builder.html"> PEP-517 builder </a>
</b>
<br/>

</td>
</tr>
