Skip to content

Commit

Permalink
style: pre-commit base checks
Browse files Browse the repository at this point in the history
  • Loading branch information
henryiii committed Jan 26, 2021
1 parent 07c3d75 commit 7ae9ded
Show file tree
Hide file tree
Showing 98 changed files with 323 additions and 292 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
THE SOFTWARE.
2 changes: 0 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,5 +193,3 @@ Colors and Styles
colors.rgb(18, 146, 64) | "or full rgb colors",
'can be used.')
print("Unsafe " + colors.bg.dark_khaki + "color access" + colors.bg.reset + " is available too.")
1 change: 0 additions & 1 deletion conda.recipe/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@
/win-32/*
/win-64/*
/outputdir/*

2 changes: 0 additions & 2 deletions conda.recipe/README.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,3 @@ anaconda login
for f in `ls outputdir/*/*.tar.bz2`; do anaconda upload $f; done
anaconda logout
```


1 change: 0 additions & 1 deletion conda.recipe/bld.bat
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
"%PYTHON%" setup.py install
if errorlevel 1 exit 1

1 change: 0 additions & 1 deletion conda.recipe/build.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
#!/bin/bash

$PYTHON setup.py install

1 change: 0 additions & 1 deletion conda.recipe/meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,3 @@ about:
home: https://plumbum.readthedocs.io
license: MIT License
summary: 'Plumbum: shell combinators library'

16 changes: 8 additions & 8 deletions docs/_cheatsheet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Basics
>>> 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
Instead of writing ``xxx = local["xxx"]`` for every program you wish to use, you can
also :ref:`import commands <import-hack>`:

>>> from plumbum.cmd import grep, wc, cat, head
>>> grep
LocalCommand(<LocalPath /bin/grep>)
Expand All @@ -36,7 +36,7 @@ Piping
------

.. code-block:: python
>>> chain = ls["-a"] | grep["-v", "\\.py"] | wc["-l"]
>>> print chain
/bin/ls -a | /bin/grep -v '\.py' | /usr/bin/wc -l
Expand All @@ -63,7 +63,7 @@ Working-directory manipulation
------------------------------

.. code-block:: python
>>> local.cwd
<Workdir /home/tomer/workspace/plumbum>
>>> with local.cwd(local.cwd / "docs"):
Expand All @@ -74,7 +74,7 @@ Working-directory manipulation
A more explicit, and thread-safe way of running a command in a differet directory is using the ``.with_cwd()`` method:

.. code-block:: python
>>> ls_in_docs = local.cmd.ls.with_cwd("docs")
>>> ls_in_docs()
'api\nchangelog.rst\n_cheatsheet.rst\ncli.rst\ncolorlib.rst\n_color_list.html\ncolors.rst\nconf.py\nindex.rst\nlocal_commands.rst\nlocal_machine.rst\nmake.bat\nMakefile\n_news.rst\npaths.rst\nquickref.rst\nremote.rst\n_static\n_templates\ntyped_env.rst\nutils.rst\n'
Expand All @@ -98,15 +98,15 @@ See :ref:`guide-local-commands-bgfg`.


Command nesting
---------------
---------------

.. code-block:: python
>>> from plumbum.cmd import sudo
>>> print sudo[ifconfig["-a"]]
/usr/bin/sudo /sbin/ifconfig -a
>>> (sudo[ifconfig["-a"]] | grep["-i", "loop"]) & FG
lo Link encap:Local Loopback
lo Link encap:Local Loopback
UP LOOPBACK RUNNING MTU:16436 Metric:1
Expand All @@ -115,7 +115,7 @@ See :ref:`guide-local-commands-nesting`.
Remote commands (over SSH)
--------------------------

Supports `openSSH <http://www.openssh.org/>`_-compatible clients,
Supports `openSSH <http://www.openssh.org/>`_-compatible clients,
`PuTTY <http://www.chiark.greenend.org.uk/~sgtatham/putty/>`_ (on Windows)
and `Paramiko <https://github.com/paramiko/paramiko/>`_ (a pure-Python implementation of SSH2)

Expand Down
1 change: 0 additions & 1 deletion docs/_news.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@
* **2015.10.16**: Version 1.6.0 released. Highlights include Python 3.5 compatibility, the ``plumbum.colors`` package, ``Path`` becoming a subclass of ``str`` and a host of bugfixes. Special thanks go to Henry for his efforts.

* **2015.07.17**: Version 1.5.0 released. This release brings a host of bug fixes, code cleanups and some experimental new features (be sure to check the changelog). Also, say hi to `Henry Schreiner <https://github.com/henryiii>`_, who has joined as a member of the project.

2 changes: 1 addition & 1 deletion docs/api/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Package plumbum.commands
.. automodule:: plumbum.commands.modifiers
:members:
:special-members:

.. automodule:: plumbum.commands.processes
:members:
:special-members:
6 changes: 0 additions & 6 deletions docs/api/machines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,3 @@ Remote Machines
.. automodule:: plumbum.machines.paramiko_machine
:members:
:special-members:






Loading

0 comments on commit 7ae9ded

Please sign in to comment.