Skip to content

Commit cc12961

Browse files
committed
rmux is born
rmux should be able to run any command on one or more remote systems. - detects current repository and rsyncs it to remote HOSTS - runs command on remote hosts - each host has its own tmux window - all tmux windows are syncronized - just type exit to return to your machine As easy as "rmux df" to see free disk space on all HOSTS.
0 parents  commit cc12961

19 files changed

+1344
-0
lines changed

.coveragerc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[run]
2+
branch = True
3+
source = rmux
4+
5+
[report]
6+
ignore_errors = True

.gitignore

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Add patterns in here to exclude files created by tools integrated with this
2+
# repository, such as test frameworks from the project's recommended workflow,
3+
# rendered documentation and package builds.
4+
#
5+
# Don't add patterns to exclude files created by preferred personal tools
6+
# (editors, IDEs, your operating system itself even). These should instead be
7+
# maintained outside the repository, for example in a ~/.gitignore file added
8+
# with:
9+
#
10+
# git config --global core.excludesfile '~/.gitignore'
11+
12+
# Bytecompiled Python
13+
*.py[cod]
14+
15+
# C extensions
16+
*.so
17+
18+
# Packages
19+
*.egg*
20+
*.egg-info
21+
dist
22+
build
23+
eggs
24+
parts
25+
bin
26+
var
27+
sdist
28+
develop-eggs
29+
.installed.cfg
30+
lib
31+
lib64
32+
33+
# Installer logs
34+
pip-log.txt
35+
36+
# Unit test / coverage reports
37+
cover/
38+
.coverage*
39+
!.coveragerc
40+
.tox
41+
nosetests.xml
42+
.testrepository
43+
.stestr
44+
.venv
45+
46+
# Translations
47+
*.mo
48+
49+
# Complexity
50+
output/*.html
51+
output/*/index.html
52+
53+
# Sphinx
54+
doc/build
55+
56+
# pbr generates these
57+
AUTHORS
58+
ChangeLog
59+
60+
# Files created by releasenotes build
61+
releasenotes/build
62+
docs/movie.app

.mailmap

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Format is:
2+
# <preferred e-mail> <other e-mail 1>
3+
# <preferred e-mail> <other e-mail 2>

.pre-commit-config.yaml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
repos:
3+
- repo: https://github.com/pre-commit/pre-commit-hooks
4+
rev: v2.1.0
5+
hooks:
6+
- id: trailing-whitespace
7+
- id: end-of-file-fixer
8+
- id: mixed-line-ending
9+
- id: check-byte-order-marker
10+
- id: check-executables-have-shebangs
11+
- id: check-merge-conflict
12+
- id: check-symlinks
13+
- id: check-vcs-permalinks
14+
- id: flake8
15+
- id: debug-statements
16+
- id: requirements-txt-fixer
17+
- id: check-yaml
18+
files: .*\.(yaml|yml)$
19+
- repo: https://github.com/adrienverge/yamllint.git
20+
rev: v1.13.0
21+
hooks:
22+
- id: yamllint
23+
files: \.(yaml|yml)$
24+
- repo: https://github.com/openstack-dev/bashate.git
25+
rev: 0.6.0
26+
hooks:
27+
- id: bashate
28+
- repo: git://github.com/Lucas-C/pre-commit-hooks-markup
29+
sha: v1.0.0
30+
hooks:
31+
- id: rst-linter

LICENSE

+175
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.

README.md

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
rmux
2+
====
3+
4+
``rmux`` allows you to run your local project on multiple remote machines in
5+
parallel.
6+
7+
The command names comes from remote-tmux as it allows multiplexing commands
8+
on multiple remote machines, synchronized.
9+
10+
The original purpose was to allow testing local changes to a project on other
11+
platforms, like running tox on another distribution.
12+
13+
![](docs/movie.gif)
14+
15+
Usage
16+
-----
17+
18+
```bash
19+
# run df locally
20+
rmux df
21+
22+
# close tmux session
23+
exit
24+
25+
# run df on two remote hosts, syncronized windows
26+
HOSTS="node1 node2" rmux df
27+
```
28+
29+
If you fail to define the ``HOSTS`` variable the tool will default to localhost
30+
but it will still use its logic of doing a rsync and running commands using
31+
tmux and ssh.
32+
33+
How it works
34+
------------
35+
36+
``rmux`` will detect current project by looking for the ``.git`` folder
37+
it in current directory or its parents. If it fails to find
38+
any ``.git`` folder, it will skip the rsync part.
39+
40+
The script will not rsync ``.gitignored`` files but it will sync untracked
41+
files.
42+
43+
The destination folder on remote machines is ``~/.cache/.rmux/<projectname>``
44+
which will also become default directory.
45+
46+
The remote user is based on host names or your ssh configuration.
47+
48+
Installation
49+
------------
50+
51+
```bash
52+
pip install rmux
53+
```
54+
55+
While ``rmux`` is currently only a pure bash script, I used pip wheel as a way
56+
to distribute it as it cross platform and easy to use. In addition, it allows
57+
me to easily upgrade it.
58+
59+
If you prefer you can
60+
just download the shell script and add it to your path.
61+
62+
See also
63+
--------
64+
65+
* [tmux](https://github.com/tmux/tmux/wiki) - terminal multiplexer
66+
* [tmux-xpanes](https://github.com/greymd/tmux-xpanes) - auto-window layout
67+
for tmux, a current requirement for rmux. Still, it should be possible to
68+
avoid using it if you have only one remote host, just make a feature request
69+
and I can implement it.
70+
* [direnv](https://direnv.net/) - define environment variables specific to current directory. This can be very handy if you want to have different set of HOSTS
71+
for each project and avoid mentioning them on the command line.
72+
* [rtox](https://pypi.org/project/rtox/) which allows running tox on remote
73+
machines this being the original project. With rmux you will no longer need
74+
rtox as you can just do `rmux tox` instead of `rtox`, the big difference
75+
being that the session is not closed automatically and that you can now
76+
run on multiple remote hosts instead of just one.
77+
78+
Links
79+
-----
80+
* Free software: Apache license
81+
* Source: https://github.com/pycontribs/rmux
82+
* Bugs: https://github.com/pycontribs/rmux/issues

docs/Makefile

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
PHONY: cast gif
2+
3+
cast:
4+
osascript movie.applescript
5+
play:
6+
asciinema play movie.cast
7+
gif:
8+
bash -c "which convert || brew install imagemagick"
9+
bash -c "which asciicast2gif || brew install asciicast2gif"
10+
bash -c "which gifsicle || brew install gifsicle"
11+
asciicast2gif -S 2 -w 160 movie.cast movie.gif

0 commit comments

Comments
 (0)