Skip to content

Commit 46df1b9

Browse files
jdufresneJoshData
authored andcommitted
Add universal wheel support (#17)
Wheels are the new standard of python distribution. For detailed information, see PEP 427. https://www.python.org/dev/peps/pep-0427/ For high level information, see: https://pythonwheels.com/ Advantages of wheels * Faster installation for pure Python packages * Avoids arbitrary code execution for installation (avoids setup.py) * Allows better caching for testing and continuous integration * Creates .pyc files as part of installation to ensure they match the python interpreter used * More consistent installs across platforms and machines As this package is pure Pythong (no C files), I have marked the wheel as universal. when you'd normally run "python setup.py sdist upload", run instead "python setup.py sdist bdist_wheel upload".
1 parent 4f611ac commit 46df1b9

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

README.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ internationalized domain but ASCII local part, the returned dict is:
268268

269269
Note that ``smtputf8`` is ``False`` even though the domain part is
270270
internationalized because
271-
`SMTPUTF8 <https://tools.ietf.org/html/rfc6531>`__ is only
271+
`SMTPUTF8 <https://tools.ietf.org/html/rfc6531>`__ is only
272272
needed if the local part of the address is internationalized (the domain
273273
part can be converted to IDNA ASCII). Also note that the ``email`` and
274274
``domain_i18n`` fields provide a normalized form of the email address
@@ -390,12 +390,13 @@ them through the validator (without deliverability checks) like so:
390390
For Project Maintainers
391391
-----------------------
392392

393-
To publish a universal wheel to pypi::
393+
The package is distributed as a universal wheel. The wheel is specified as
394+
universal in the file ``setup.cfg`` by the ``universal = 1`` key in the
395+
``[bdist_wheel]`` section. To publish a universal wheel to pypi::
394396

395397
pip3 install twine
396398
rm -rf dist
397-
python3 setup.py bdist_wheel --universal
399+
python3 setup.py bdist_wheel
398400
twine upload dist/*
399401
git tag v1.0.XXX
400402
git push --tags
401-

setup.cfg

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[bdist_wheel]
2+
universal = 1
3+
4+
[metadata]
5+
license_file = LICENSE

0 commit comments

Comments
 (0)