Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding more documentation for python_app #5965

Merged
merged 3 commits into from
Jun 16, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/python/pants/backend/python/targets/python_app.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@


class PythonApp(AppBase):
"""A deployable Python application.

Invoking the ``bundle`` goal on one of these targets creates a
self-contained artifact suitable for deployment on some other machine.
The artifact contains the executable pex, its dependencies, and
extra files like config files, startup scripts, etc.

:API: public
"""

@classmethod
def alias(cls):
return 'python_app'
Expand Down
4 changes: 2 additions & 2 deletions src/python/pants/build_graph/app_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,8 @@ def __init__(self,
archive=None,
**kwargs):
"""
:param string binary: Target spec of the ``jvm_binary`` that contains the
app main.
:param string binary: Target spec of the ``jvm_binary`` or the ``python_binary``
that contains the app main.
:param bundles: One or more ``bundle``\s
describing "extra files" that should be included with this app
(e.g.: config files, startup scripts).
Expand Down