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.

Sign up for GitHub

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

Jump to bottom

Small touchup for readme #469

Merged
merged 3 commits into from
Sep 27, 2019
Merged

Small touchup for readme #469

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
00cd55b
Small touchup for readme
henryiii Sep 23, 2019
d3e4a36
Adding note about local.cmd
henryiii Sep 24, 2019
c15d707
Make local.cmd.ls the default
henryiii Sep 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 4 additions & 11 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,23 +54,16 @@ Basics
.. code-block:: python

>>> from plumbum import local
>>> ls = local["ls"]
>>> ls
>>> local.cmd.ls
LocalCommand(<LocalPath /bin/ls>)
>>> ls()
>>> local.cmd.ls()
u'build.py\ndist\ndocs\nLICENSE\nplumbum\nREADME.rst\nsetup.py\ntests\ntodo.txt\n'
>>> notepad = local["c:\\windows\\notepad.exe"]
>>> notepad() # Notepad window pops up
u'' # Notepad window is closed by user, command returns

Instead of writing ``xxx = local["xxx"]`` for every program you wish to use, you can
also ``import`` commands

.. code-block:: python

>>> from plumbum.cmd import grep, wc, cat, head
>>> grep
LocalCommand(<LocalPath /bin/grep>)
In the example above, you can use ``local["ls"]`` if you have an unusually named executable or a full path to an executable. The `local` object represents your local machine. As you'll see, Plumbum also provides remote machines that use the same API!
You can also use ``from plumbum.cmd import ls`` as well for accessing programs in the ``PATH``.

Piping
******
Expand Down