techtonik / pypack Goto Github PK

View Code? Open in Web Editor NEW

4.0 1.0 3.0 24 KB

Quickly pack .py module into source distribution

Home Page: https://pypi.python.org/pypi/pypack

License: The Unlicense

Python 100.00%

release-automation pypi python packaging

pypack's Introduction

No boilerplate way to create (executable) source packages for Python modules.

$ python -m pypack appvey.py
[*] Packing appvey.py into appvey-1234.zip
[*] Making appvey-1234.zip executable
[*] Making appvey-1234.zip installable
[*] Making appvey-1234.zip uploadable to PyPI

See also:

Features

No packaging boilerplate
Executable .zip file if module provides main() function
Command line script entry for the main() function
requirements.txt detected and included

Changes

1.0 - Python 3 compatibility fix

Details

Necessary package fields are read from the .py module, without imporing it:

name - extracted from the module filename
__author__
__version__
__url__

Also detects and restores these optional fields:

__license__
description - first line of module docstring

Python packaging still relies on setup.py, so it is created automatically (but this may change with PEP-517 and PEP-518).

requirements.txt should use safe setuptools subset pypa/setuptools#1080 (comment)

main() function is required to enable executable features.

Checklist for packaging your module for PyPI

Pack your module into .zip archive
```
  pypack.py <module.py>
```
Write changelog
Tag release
```
git tag -a
git push --follow-tags
```
Upload archive to PyPI
```
twine upload <package.zip>
```

pypack's People

Contributors

Stargazers

Watchers

Forkers

pombredanne daleathan 3krish

pypack's Issues

Insert README.md into long_description

pypack PyPI page is empty after release. There could be content.

twine check

https://pypi.org/help/#description-content-type

Do not generate executable if main() is not found

Do not make anything executable if module doesn't expose main() function.

Traceback (most recent call last):
  File "__main__.py", line 4, in <module>
    sys.exit(appvey.main())
AttributeError: 'module' object has no attribute 'main'

Instead show a message;

* [x] main() is not found, skip executables

Generate executable script for the module

It is inconvenient to call python -m <module> after installation.

http://python-packaging.readthedocs.io/en/latest/command-line-scripts.html

Generate PEP-518

https://www.python.org/dev/peps/pep-0518/ replaces dynamic setup.py (which is hard to parse) with static pyproject.toml, and it is better to generate the latter than the former.

Read dependencies from requirements.txt

If requirements.txt is present, read dependencies into generated setup.py file.

Deploy on tag

generate PyPI token for deployment
encrypt token for .travis.yml and add it there

$ travis encrypt -r techtonik/pypack --org

modify .travis.yml to execute commands on tag
add commands for uploading pypack on tag

0.2 and 0.3 are broken on Python 3

0.1 was ok - https://travis-ci.org/techtonik/python-patch/jobs/160276595
0.3 is not - https://travis-ci.org/techtonik/python-patch/jobs/577891157#L186

Traceback (most recent call last):
  File "/opt/python/3.4.8/lib/python3.4/runpy.py", line 170, in _run_module_as_main
    "__main__", mod_spec)
  File "/opt/python/3.4.8/lib/python3.4/runpy.py", line 85, in _run_code
    exec(code, run_globals)
  File "/home/travis/virtualenv/python3.4.8/lib/python3.4/site-packages/pypack.py", line 202, in <module>
    main()
  File "/home/travis/virtualenv/python3.4.8/lib/python3.4/site-packages/pypack.py", line 185, in main
    if not get_main(modpath):
  File "/home/travis/virtualenv/python3.4.8/lib/python3.4/site-packages/pypack.py", line 59, in get_main
    if line.startswith('def main('):
TypeError: startswith first arg must be bytes or a tuple of bytes, not str
The command "python -m pypack patch.py" exited with 1.