Eclectic Media Git run_in_split / master
Adds a README - Also adds an AUTHORS file. - Also adds a CHANGLEOG. - Also adds a LICENSE. Ariana Giroux 5 months ago
4 changed file(s) with 98 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
0 - Ariana Giroux <ariana.giroux@gmail.com:FEED41C6F26B4E0EB52BDFA1510EF70B4B42770D>
0 * [eae6d80: Ariana Giroux] Adds a README
1
2 - Also adds an AUTHORS file.
3
4 - Also adds a CHANGLEOG.
5
6 - Also adds a LICENSE.
7
8 ---
9 * [a645731: Ariana Giroux] Updates to version 0.2!
10
11 - Adds '--small'
12
13 - Minor bugfixing!
14
15 ---
16 * [011c909: Ariana Giroux] Created a small option, runs in small pane
17
18
19 ---
20 * [cd5788f: Ariana Giroux] Added __init__.py file f/ module
21
22
23 ---
24 * [3916489: Ariana Giroux] Added a gitignore
25
26
27 ---
28 * [286747a: Ariana Giroux] Initial commit
29
30
31 ---
0 Copyright 2019 Ariana Giroux <ariana.giroux@gmail.com> [FEED41C6F26B4E0EB52BDFA1510EF70B4B42770D]
1
2 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
3
4 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
5
6 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 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.
0 Run a command in a TMUX pane
1 ============================
2
3 Have you ever been working on your command line and wanted command or script to run in a 'popup' inside your command line? Do you use TMUX? Well, look no further!
4
5 This script provides a simple method for running a script in a new TMUX pane, without having to memorize a bunch of modifiers.
6
7 Usage
8 =====
9
10 Using the software is simple. ::
11
12 run_in_split [OPTIONS] COMMAND
13
14 Options:
15 --horizontal Split pane horizontally.
16 --sleep If true, sleep for five seconds after the command exits.
17 --pause If true, pause until user presses enter.
18 --pause-on-error If true, pause until user presses enter only if the
19 process does not exit 0.
20 --small Creates pane at 15% of total screen space
21 --help Show this message and exit.
22
23
24 For example, to run a ``git push`` in a pane that will pause if the push fails: ::
25
26 run_in_split --pause-on-error git push
27
28 Installation
29 ============
30
31 This package can be installed via ``pip``, but is not hosted on pypi.
32
33 First, clone this repository: ::
34
35 git clone git://git.eclecticmedia.space/public/run_in_split
36
37 Then, from the resulting directory, simply run the setup script: ::
38
39 python setup.py install
40
41 - OR -
42
43 pip install .
44
45 If you need to include this package in your ``requirements.txt`` file, you can do so using the following line: ::
46
47 -e git://git.eclecticmedia.space/public/run_in_split#egg=run_in_split
48
49
50 Contribution
51 ============
52
53 We use a git-native forking workflow. For more information on how that works, check `this article`_.
54
55 Submit a pull-request by using ``git request-pull -p *FEATURE BRANCH* origin`` and attaching the subsequent text to an email addressed to ``ariana.giroux+contributions@gmail.com``
56
57 .. _`this article`: https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow