Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e563cbe

Browse files
authored
Merge pull request #1 from xonssh/v0.1
xonssh-xxh-0.1
2 parents 5d9095d + b9b51d7 commit e563cbe

File tree

13 files changed

+334
-308
lines changed

13 files changed

+334
-308
lines changed

‎.gitignore‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
*.pyc
2+
*.out
3+
*.xcf
4+
*.egg
5+
.eggs/
6+
.pytest_cache/
7+
build/
8+
dist/
9+
xonssh_xxh.egg-info/
10+
venv/
11+
12+
# temporary files from vim and emacs
13+
*~
14+
*#
15+
.#*
16+
*.swp
17+
*.swo
18+
19+
# Editor project files
20+
*.komodo*
21+
.cache
22+
.idea
23+
.vscode/
24+
25+
# Mac
26+
.DS_Store

‎LICENSE‎

Lines changed: 25 additions & 201 deletions
Original file line numberDiff line numberDiff line change
@@ -1,201 +1,25 @@
1-
Apache License
2-
Version 2.0, January 2004
3-
http://www.apache.org/licenses/
4-
5-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6-
7-
1. Definitions.
8-
9-
"License" shall mean the terms and conditions for use, reproduction,
10-
and distribution as defined by Sections 1 through 9 of this document.
11-
12-
"Licensor" shall mean the copyright owner or entity authorized by
13-
the copyright owner that is granting the License.
14-
15-
"Legal Entity" shall mean the union of the acting entity and all
16-
other entities that control, are controlled by, or are under common
17-
control with that entity. For the purposes of this definition,
18-
"control" means (i) the power, direct or indirect, to cause the
19-
direction or management of such entity, whether by contract or
20-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21-
outstanding shares, or (iii) beneficial ownership of such entity.
22-
23-
"You" (or "Your") shall mean an individual or Legal Entity
24-
exercising permissions granted by this License.
25-
26-
"Source" form shall mean the preferred form for making modifications,
27-
including but not limited to software source code, documentation
28-
source, and configuration files.
29-
30-
"Object" form shall mean any form resulting from mechanical
31-
transformation or translation of a Source form, including but
32-
not limited to compiled object code, generated documentation,
33-
and conversions to other media types.
34-
35-
"Work" shall mean the work of authorship, whether in Source or
36-
Object form, made available under the License, as indicated by a
37-
copyright notice that is included in or attached to the work
38-
(an example is provided in the Appendix below).
39-
40-
"Derivative Works" shall mean any work, whether in Source or Object
41-
form, that is based on (or derived from) the Work and for which the
42-
editorial revisions, annotations, elaborations, or other modifications
43-
represent, as a whole, an original work of authorship. For the purposes
44-
of this License, Derivative Works shall not include works that remain
45-
separable from, or merely link (or bind by name) to the interfaces of,
46-
the Work and Derivative Works thereof.
47-
48-
"Contribution" shall mean any work of authorship, including
49-
the original version of the Work and any modifications or additions
50-
to that Work or Derivative Works thereof, that is intentionally
51-
submitted to Licensor for inclusion in the Work by the copyright owner
52-
or by an individual or Legal Entity authorized to submit on behalf of
53-
the copyright owner. For the purposes of this definition, "submitted"
54-
means any form of electronic, verbal, or written communication sent
55-
to the Licensor or its representatives, including but not limited to
56-
communication on electronic mailing lists, source code control systems,
57-
and issue tracking systems that are managed by, or on behalf of, the
58-
Licensor for the purpose of discussing and improving the Work, but
59-
excluding communication that is conspicuously marked or otherwise
60-
designated in writing by the copyright owner as "Not a Contribution."
61-
62-
"Contributor" shall mean Licensor and any individual or Legal Entity
63-
on behalf of whom a Contribution has been received by Licensor and
64-
subsequently incorporated within the Work.
65-
66-
2. Grant of Copyright License. Subject to the terms and conditions of
67-
this License, each Contributor hereby grants to You a perpetual,
68-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69-
copyright license to reproduce, prepare Derivative Works of,
70-
publicly display, publicly perform, sublicense, and distribute the
71-
Work and such Derivative Works in Source or Object form.
72-
73-
3. Grant of Patent License. Subject to the terms and conditions of
74-
this License, each Contributor hereby grants to You a perpetual,
75-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76-
(except as stated in this section) patent license to make, have made,
77-
use, offer to sell, sell, import, and otherwise transfer the Work,
78-
where such license applies only to those patent claims licensable
79-
by such Contributor that are necessarily infringed by their
80-
Contribution(s) alone or by combination of their Contribution(s)
81-
with the Work to which such Contribution(s) was submitted. If You
82-
institute patent litigation against any entity (including a
83-
cross-claim or counterclaim in a lawsuit) alleging that the Work
84-
or a Contribution incorporated within the Work constitutes direct
85-
or contributory patent infringement, then any patent licenses
86-
granted to You under this License for that Work shall terminate
87-
as of the date such litigation is filed.
88-
89-
4. Redistribution. You may reproduce and distribute copies of the
90-
Work or Derivative Works thereof in any medium, with or without
91-
modifications, and in Source or Object form, provided that You
92-
meet the following conditions:
93-
94-
(a) You must give any other recipients of the Work or
95-
Derivative Works a copy of this License; and
96-
97-
(b) You must cause any modified files to carry prominent notices
98-
stating that You changed the files; and
99-
100-
(c) You must retain, in the Source form of any Derivative Works
101-
that You distribute, all copyright, patent, trademark, and
102-
attribution notices from the Source form of the Work,
103-
excluding those notices that do not pertain to any part of
104-
the Derivative Works; and
105-
106-
(d) If the Work includes a "NOTICE" text file as part of its
107-
distribution, then any Derivative Works that You distribute must
108-
include a readable copy of the attribution notices contained
109-
within such NOTICE file, excluding those notices that do not
110-
pertain to any part of the Derivative Works, in at least one
111-
of the following places: within a NOTICE text file distributed
112-
as part of the Derivative Works; within the Source form or
113-
documentation, if provided along with the Derivative Works; or,
114-
within a display generated by the Derivative Works, if and
115-
wherever such third-party notices normally appear. The contents
116-
of the NOTICE file are for informational purposes only and
117-
do not modify the License. You may add Your own attribution
118-
notices within Derivative Works that You distribute, alongside
119-
or as an addendum to the NOTICE text from the Work, provided
120-
that such additional attribution notices cannot be construed
121-
as modifying the License.
122-
123-
You may add Your own copyright statement to Your modifications and
124-
may provide additional or different license terms and conditions
125-
for use, reproduction, or distribution of Your modifications, or
126-
for any such Derivative Works as a whole, provided Your use,
127-
reproduction, and distribution of the Work otherwise complies with
128-
the conditions stated in this License.
129-
130-
5. Submission of Contributions. Unless You explicitly state otherwise,
131-
any Contribution intentionally submitted for inclusion in the Work
132-
by You to the Licensor shall be under the terms and conditions of
133-
this License, without any additional terms or conditions.
134-
Notwithstanding the above, nothing herein shall supersede or modify
135-
the terms of any separate license agreement you may have executed
136-
with Licensor regarding such Contributions.
137-
138-
6. Trademarks. This License does not grant permission to use the trade
139-
names, trademarks, service marks, or product names of the Licensor,
140-
except as required for reasonable and customary use in describing the
141-
origin of the Work and reproducing the content of the NOTICE file.
142-
143-
7. Disclaimer of Warranty. Unless required by applicable law or
144-
agreed to in writing, Licensor provides the Work (and each
145-
Contributor provides its Contributions) on an "AS IS" BASIS,
146-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147-
implied, including, without limitation, any warranties or conditions
148-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149-
PARTICULAR PURPOSE. You are solely responsible for determining the
150-
appropriateness of using or redistributing the Work and assume any
151-
risks associated with Your exercise of permissions under this License.
152-
153-
8. Limitation of Liability. In no event and under no legal theory,
154-
whether in tort (including negligence), contract, or otherwise,
155-
unless required by applicable law (such as deliberate and grossly
156-
negligent acts) or agreed to in writing, shall any Contributor be
157-
liable to You for damages, including any direct, indirect, special,
158-
incidental, or consequential damages of any character arising as a
159-
result of this License or out of the use or inability to use the
160-
Work (including but not limited to damages for loss of goodwill,
161-
work stoppage, computer failure or malfunction, or any and all
162-
other commercial damages or losses), even if such Contributor
163-
has been advised of the possibility of such damages.
164-
165-
9. Accepting Warranty or Additional Liability. While redistributing
166-
the Work or Derivative Works thereof, You may choose to offer,
167-
and charge a fee for, acceptance of support, warranty, indemnity,
168-
or other liability obligations and/or rights consistent with this
169-
License. However, in accepting such obligations, You may act only
170-
on Your own behalf and on Your sole responsibility, not on behalf
171-
of any other Contributor, and only if You agree to indemnify,
172-
defend, and hold each Contributor harmless for any liability
173-
incurred by, or claims asserted against, such Contributor by reason
174-
of your accepting any such warranty or additional liability.
175-
176-
END OF TERMS AND CONDITIONS
177-
178-
APPENDIX: How to apply the Apache License to your work.
179-
180-
To apply the Apache License to your work, attach the following
181-
boilerplate notice, with the fields enclosed by brackets "[]"
182-
replaced with your own identifying information. (Don't include
183-
the brackets!) The text should be enclosed in the appropriate
184-
comment syntax for the file format. We also recommend that a
185-
file or class name and description of purpose be included on the
186-
same "printed page" as the copyright notice for easier
187-
identification within third-party archives.
188-
189-
Copyright [yyyy] [name of copyright owner]
190-
191-
Licensed under the Apache License, Version 2.0 (the "License");
192-
you may not use this file except in compliance with the License.
193-
You may obtain a copy of the License at
194-
195-
http://www.apache.org/licenses/LICENSE-2.0
196-
197-
Unless required by applicable law or agreed to in writing, software
198-
distributed under the License is distributed on an "AS IS" BASIS,
199-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200-
See the License for the specific language governing permissions and
201-
limitations under the License.
1+
Copyright 2019-2020, the xonsh developers. All rights reserved.
2+
3+
Redistribution and use in source and binary forms, with or without modification, are
4+
permitted provided that the following conditions are met:
5+
6+
1. Redistributions of source code must retain the above copyright notice, this list of
7+
conditions and the following disclaimer.
8+
9+
2. Redistributions in binary form must reproduce the above copyright notice, this list
10+
of conditions and the following disclaimer in the documentation and/or other materials
11+
provided with the distribution.
12+
13+
THIS SOFTWARE IS PROVIDED BY THE XONSH DEVELOPERS ``AS IS'' AND ANY EXPRESS OR IMPLIED
14+
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
15+
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE XONSH DEVELOPERS OR
16+
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
17+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
18+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
19+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
20+
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
21+
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22+
23+
The views and conclusions contained in the software and documentation are those of the
24+
authors and should not be interpreted as representing official policies, either expressed
25+
or implied, of the stakeholders of the xonssh project or the employers of xonssh developers.

‎README.md‎

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,12 @@
99
<a href="https://asciinema.org/a/osSEzqnmH9pMYEZibNe2K7ZL7" target="_blank"><img src="https://asciinema.org/a/osSEzqnmH9pMYEZibNe2K7ZL7.svg"></a>
1010
</p>
1111

12+
[![PyPI Latest Release](https://img.shields.io/pypi/v/xonssh-xxh.svg)](https://pypi.org/project/xonssh-xxh/) [![Package Status](https://img.shields.io/pypi/status/xonssh-xxh.svg)](https://pypi.org/project/xonssh-xxh/)
1213

1314
## Installation
14-
Run in your xonsh:
15+
Run:
1516
```
16-
git clone --depth 1 https://github.com/xonssh/xxh ~/.xxh
17-
echo "aliases['xxh'] = 'xonsh ~/.xxh/xxh.xsh'" >> ~/.xonshrc
18-
aliases['xxh'] = 'xonsh ~/.xxh/xxh.xsh'
17+
pip install xonssh-xxh
1918
```
2019
Then try:
2120
```
@@ -24,26 +23,41 @@ xxh <server>
2423

2524
## Usage
2625
```
27-
> xxh -h
28-
usage: xxh.xsh [-h] [-i] [-p TARGET_PATH] [-m METHOD] [-f] server
26+
$ xxh -h
27+
usage: xxh [-h] [-i] [-if] [-rxh REMOTE_XXH_HOME] [-m METHOD]
28+
[-lxh LOCAL_XXH_HOME] [-V]
29+
[destination]
30+
31+
The xxh is for using the xonsh shell wherever you go through the ssh.
32+
33+
___ _________ @ @
34+
_____ / \ \__/
35+
___ / ____ \ / \ contribution
36+
____ / / \ \ / _/ https://github.com/xonssh/xxh
37+
__ ( \ \_/ ) /
38+
\ \_____/ / / plugins
39+
__\___________/ / https://github.com/search?q=xxh-plugin
40+
/_________________/
2941
3042
positional arguments:
31-
server Destination may be specified as hostname or server
32-
name from ~/.ssh/config
43+
destination Destination may be specified as hostname or server name from ~/.ssh/config
3344
3445
optional arguments:
3546
-h, --help show this help message and exit
36-
-i, --install Install xonsh to host
37-
-p TARGET_PATH, --target-path TARGET_PATH
38-
Target path. Default: ~/.xxh
47+
-i, --install Install xxh to distanation host
48+
-if, --install-force Delete remote xxh home and install xonsh to distanation host
49+
-rxh REMOTE_XXH_HOME, --remote-xxh-home REMOTE_XXH_HOME
50+
Set the remote xxh home directory. Default: ~/.xxh
3951
-m METHOD, --method METHOD
40-
Currently supported single 'appimage' method
41-
-f, --force Delete target directory when install xonsh to host
52+
Installation method. Currently supported only 'appimage' method
53+
-lxh LOCAL_XXH_HOME, --local-xxh-home LOCAL_XXH_HOME
54+
Local xxh home path. Default: ~/.xxh
55+
-V, --version Show xxh version
4256
```
4357

4458
## Plugins
4559

46-
You can [add or create plugins to xxh with your own lovely functions](plugins/README.md).
60+
[Search xxh plugins on Github](https://github.com/search?q=xxh-plugin) or [create plugin with your own lovely functions](README.plugins.md).
4761

4862
## Notes
4963

@@ -53,7 +67,7 @@ The xxh xonsh will use pip and python from `xonsh.AppImage` by default. You can
5367

5468
### Shortcut to reinstall xxh on host
5569
```
56-
xxh <server> -i -f
70+
xxh <server> -if
5771
```
5872

5973
## How it works?
@@ -86,3 +100,5 @@ Current method to make xonsh portable is using an [AppImage](https://appimage.or
86100
Unknown answer from server when checking direcotry /home/hansolo/.xxh:
87101
```
88102
This issue was addressed to Xonsh team in [3367](https://github.com/xonsh/xonsh/issues/3367). Just try to run command again.
103+
104+
WSL2 is not tested yet.
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22

33
## xxh plugins list
44

5+
[Search xxh plugins on Github](https://github.com/search?q=xxh-plugin)
6+
7+
Pinned plugins:
8+
59
* [Pipe Liner](https://github.com/xonssh/xxh-plugin-pipe-liner)
610
* [Bar Theme](https://github.com/xonssh/xxh-plugin-theme-bar)
711
* [Autojump](https://github.com/xonssh/xxh-plugin-autojump)
812

9-
[Search more xxh plugins on Github](https://github.com/search?q=xxh-plugin)
10-
1113
## Install xxh plugin
1214

1315
To install xxh plugin just place the plugin directory to the `plugins`. Example:

‎__init__.py‎

Whitespace-only changes.

‎requirements.txt‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎setup.py‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import setuptools
2+
from xonssh_xxh.settings import global_settings
3+
4+
setuptools.setup(
5+
name="xonssh-xxh", # Replace with your own username
6+
version=global_settings['XXH_VERSION'],
7+
description="xxh is for using portable xonsh shell wherever you go through the ssh",
8+
url="https://github.com/xonssh/xxh",
9+
python_requires='>=3.6',
10+
install_requires=['xonsh'],
11+
platforms='Unix-like',
12+
scripts=['xxh'],
13+
package_data={'xonssh_xxh':['*.xsh']},
14+
packages=setuptools.find_packages(),
15+
classifiers=["Programming Language :: Python :: 3"],
16+
license="BSD",
17+
author="xonssh",
18+
author_email="[email protected]"
19+
)

‎xonssh_xxh/__init__.py‎

Whitespace-only changes.

‎xonssh_xxh/settings.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import sys
2+
3+
global_settings = {
4+
'XXH_VERSION': '0.1'
5+
}
6+
7+
if __name__ == "__main__":
8+
if len(sys.argv) > 1:
9+
setting_name = sys.argv[1]
10+
if setting_name in global_settings:
11+
print(global_settings[setting_name])
12+
else:
13+
sys.exit(1)
14+
else:
15+
print(global_settings)

0 commit comments

Comments
 (0)