aeroxis / sultan

Sultan: Command and Rule over your Shell

Command and Rule over your Shell

Sultan now supports Python 2.7+ and 3.0+

Note

Your input is welcome! Please provide your feedback by creating issues on Github

Install

pip install --upgrade sultan

Documentation

Documentation is available on ReadTheDocs: http://sultan.readthedocs.io/en/latest/

What is Sultan?

Sultan is a Python package for interfacing with command-line utilities, like yum, apt-get, or ls, in a Pythonic manner. It lets you run command-line utilities using simple function calls.

The simplest way to use Sultan is to just call it:

from sultan.api import Sultan
s = Sultan()
s.sudo("yum install -y tree").run()

Runs:

sudo yum install -y tree;

---

The recommended way of using Sultan is to use it in Context Management mode. Here is how to use Sultan with Context Management:

from sultan.api import Sultan

with Sultan.load(sudo=True) as s:
  s.yum("install -y tree").run()

Runs:

sudo su - root -c 'yum install -y tree;'

---

What if we want to install this command on a remote machine? You can easily achieve this using context management:

from sultan.api import Sultan

with Sultan.load(sudo=True, hostname="myserver.com") as sultan:
  sultan.yum("install -y tree").run()

Runs:

ssh [email protected] 'sudo su - root -c 'yum install -y tree;''

---

If you enter a wrong command, Sultan will print out details you need to debug and find the problem quickly.

Here, the same command was run on a Mac:

from sultan.api import Sultan

with Sultan.load(sudo=True, hostname="myserver.com") as sultan:
  sultan.yum("install -y tree").run()

Yields:

[sultan]: sudo su - root -c 'yum install -y tree;'
Password:
[sultan]: --{ STDERR }-------------------------------------------------------------------------------------------------------
[sultan]: | -sh: yum: command not found
[sultan]: -------------------------------------------------------------------------------------------------------------------

---

Want to get started? Simply install Sultan, and start writing your clean code:

pip install --upgrade sultan

If you have more questions, check the docs! http://sultan.readthedocs.io/en/latest/

sultan's Issues

Hyphenated commands: Using apt-get like yum was used in the examples

In the examples, the following very elegant syntax is used to install something with yum:

with Sultan.load(sudo=True, hostname="myserver.com") as sultan:
  sultan.yum("install -y tree").run()

I'd love to use this with apt-get, but the hyphen collides with Python syntax, obviously. Is there a way to achieve that?

Of course I could do sultan.sudo("apt-get install ...").run(), but I really like the idea of having the sudo in the contest.

Tried apt_get, which fails as _ is not replaced, probably for good reason.

Possible merger with Fabric?

Hi author of Sultan, I just noticed your project from Hacker News. Sorry if this sounds stupid. It is subjective, I know but I am going to give my opinions anyway.

There is this awesome project called 'Fabric' for automating tasks using command line utilities through Python, and much more. We have already used that in place of Ansible and it served pretty well for us. I believe both of the projects (Sultan & Fabric) serves the same purpose, while Fabric doing much more (not being offensive).

Right now Fabric has reached a tipping point as mentioned in the Roadmap. So why not contribute the best parts of your project to Fabric so that it benefits Fabric's code base.

For your reference,

1. Invoke
2. Fabric

Please close this if this is completely ridiculous.

Set which command to run

Is there a way to set the command that sultan runs?

from sultan.api import Sultan
with Sultan.load() as c:
  c.mv(CFGFILE,NEWCFGFILE).run()

I run at a bash command line the following:
which mv
i get:
alias mv='mv -i'
/usr/bin/mv

I believe my c.mv command is doing /usr/bin/mv but I was wondering if there is a way to make sure? BTW I'm using mv as an example as I have a much more complex issue but the answer to this will help.

Problems when sourcing a file

Hi,

When sourcing a file, the sourcing process happens in the dir that the script is running and not in the one specified by cwd. For instance, if one is in /foo and the script below is in /foo/bar/baz, the variable var is equal to foo and not baz. It's possible to add a flag indicating where the sourcing happens?

export var=$(basename $(pwd))

Also, the path src script must always be absolute or can be relative to cwd?

with Sultan.load(
        cwd='/foo/bar',
        src='baz/config.sh') as s:
    s.pip(...)

Regards

Sultan does not throw an error on `mv` if the destination directory does not have right permissions

It appears that Sultan isn't throwing any errors if the user doesn't have permissions to do a mv. It simply swallows it, and the error doesn't get thrown.

with Sultan.load() as s:
    s.mv(source_file, deployed).run()

Also, why is it swallowing errors and not throwing them if it encounters it?

No logging option?

Hi ~ First of all: this is awesome!
Second, is there a way to remove sultan logging?

txtx!

Allow users to import from sultan directly.

https://www.reddit.com/r/Python/comments/79wihj/sultan_pythonic_interface_to_your_shell/dp6ec5i/?utm_content=permalink&utm_medium=front&utm_source=reddit&utm_name=Python

So, this should simplify the syntax from from sultan.api import Sultan to from sultan import Sultan

Add support for Bash's OR operator

We currently support And &&. We need support for Or ||

||
OR

if [ $condition1 ] || [ $condition2 ]
# Same as:  if [ $condition1 -o $condition2 ]
# Returns true if either condition1 or condition2 holds true...

if [[ $condition1 || $condition2 ]]    # Also works.
#  Note that || operator not permitted inside brackets
#+ of a [ ... ] construct.

Source: http://www.tldp.org/LDP/abs/html/ops.html

ssh ProxyCommand support

Is possible to connect to an ssh tunnel through the ProxyCommand ssh option?

Sultan.load() vs Sultan()

In Streaming Results from a Command we see:

with Sultan.load() as s:
    result = s.yum('install', '-y', 'postgresql').run(streaming=True)
    while True:
        # if full output is needed, read the pipes one last time
        # after `is_complete == True` to avoid a race condition
        complete = result.is_complete
        for line in result.stdout:
            print(line)
        for line in result.stderr:
            print(line)
        if complete:
            break
        time.sleep(1)

My question is: how different would this code be if Sultan.load() were replaced with Sultan().

Use custom ssh key (ssh -i)

In Sultan context for remote host, is there a way to connect to remote host with a custom SSH key? Like one would otherwise do with ssh -i mykeyfile.pem user@host.

Thank you!

Fix how sudo works so that we're not going as the root user to just run a command.

More details here: https://www.reddit.com/r/commandline/comments/6gqljj/command_and_rule_over_your_shell_with_python/disg3u0/?utm_content=permalink&utm_medium=front&utm_source=reddit&utm_name=commandline

Getting output on SSH connection

Is there any way to get STDOUT or STDERR streams as strings or lists from the sultan API? I am particularly interested in the remote SSH based commands.

Use custom user for SSH connection

Hi,

I think it would be useful to be able to select which user to use when running an SSH connection. The syntax could be something like: with Sultan.load(hostname='[email protected]') as sultan.

It currently tries to connect me as jenselme@[email protected] which is invalid.

Use async/await pattern with sultan

Hi,

I am using the async/await keywords in more and more programs to easily do asynchronous tasks in Python and I would be interested in using when doing shell commands with sultan. Is it something you are considering or are interested in?

If you want more information on how this can work, I found this post that given some information on this. I'd also be willing to contribute to add async/await to sultan.

Windows cygwin support

There should be a way to specify Cygwin base directory while loading Sultan.
This would able to use Sultan in Windows as well.

Thanks,
Puneet

How to run commands with other punctuation

I have a command on windows named az.cmd

How can I run it with Sultan?
Thanks,
Rick

Current test suite has partial failures: 2 of 45

Platform: macOS
Sultan version: 0.8.1 (git-clone of repo today)

Failures occur w/ both Python 2.7 and Python 3.7.

...
FAIL: test_custom_executable (integration.sultan.test_api.SultanExecutable)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/jens/se_inspect/_topic.cmdrunner/aeroxis_sultan/test/integration/sultan/test_api.py", line 58, in test_custom_executable
    self.assertEqual(result.stdout[0], 'bash')
AssertionError: '/bin/bash' != 'bash'
-------------------- >> begin captured logging << --------------------
sultan: DEBUG: ps | grep `echo $$` | awk '{ print $4 }';
--------------------- >> end captured logging << ---------------------

======================================================================
FAIL: test_default_executable (integration.sultan.test_api.SultanExecutable)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/jens/se_inspect/_topic.cmdrunner/aeroxis_sultan/test/integration/sultan/test_api.py", line 52, in test_default_executable
    self.assertEqual(result.stdout[0], 'sh')
AssertionError: '/bin/sh' != 'sh'
-------------------- >> begin captured logging << --------------------
sultan: DEBUG: ps | grep `echo $$` | awk '{ print $4 }';
--------------------- >> end captured logging << ---------------------

SSH command completion

Sultan is not able to detect SSH command completion. However if you Ctrl+C the first instance of the command and re-run it a second time, things work well.

Here is a code sample of what I am using:

with Sultan.load(hostname='10.0.0.1', user='ubuntu', log=True) as sultan:
            sultan.sudo("apt-get update").run()

This is repeatable through pretty much all commands.

Ability to have contextual information like current directory or user that can be retrieved by the commands

Ability to set and use contextual information:

• Current Working Directory
• Current User (that is running the script)
• The time that the scripts began to run

Perhaps with a with block, like:

sultan = Sultan()
with sultan.context(pwd="/tmp/archive_dir", as="davydany") as sultan:
    sultan.ls("-lt")

Unreachable code in api.py

Hi, I was reading Sultan's code and PyCharm highlighted a piece of code that makes some code unreachable.

It seems like David Daniel's commit of 30th November made lines 222 to 288 impossible to execute as they follow a return statement (line 219).

observing error No module named api

Traceback (most recent call last):
File "su.py", line 3, in
from sultan.api import *
File "/var/www/html/sultan.py", line 3, in
ImportError: No module named api

import sultan
Traceback (most recent call last):
File "", line 1, in
File "/var/www/html/sultan.py", line 3, in
ImportError: No module named api

from sultan.api import Sultan
Traceback (most recent call last):
File "", line 1, in
File "/var/www/html/sultan.py", line 3, in
ImportError: No module named api

Store the command's return code

Currently there's no way to access the RC of a command - and a lot of tools use it to convey information to the user.

As an Aeroxis Developer, I don't want Sultan Turban too look like a phallic Symbol.

Since it looks like a penis to some folks, I need to come up with a change to the logo so that the turban doesn't look like one.

.run() outputs [sultan] command

When I run my python3 script sultan outputs to the console which I control. Is there a way to stop this and/or grab this for later display?

question: context manager on a new bash or "su -" shell

Hello there,
thanks for this very cool project!

I didn't understand if it's possible to use the with Sultan.load block to emulate a new user (like the su - USER command) or eventually a new bash with new variables.

question: support <port> option for remote host

Hi Sultan team,

Thank you for developing and sharing this package. Is it possible to provide an SSH port number, alternative to 22 via the API? I know I could workaround this using an .ssh/config setting. I'd prefer to have this ability supported natively in the API if possible.

Cheers,
-- Jeremy

FINAL: Release 0.2 Features

FINAL

To do:

Completed:

• Better color schemes. Right now DEBUG is just white and it makes it odd to read. The color schemes should reflect what the level implies.
• Errors and Stdout should be better formatted with logging. If an exception happens, we see a traceback, which is useless. The stderr and stdout should be more nicely formatted and presented to the user when an error occurs.
• We can use raw_input to get input via stdin, but it would be nice if the Sultan API also supported it.
• Context Management:
  • sudo=<True/False>: Set a command should be run as sudo with Context Management.
  • user=<username>: Set a user to run command as
  • host=<hostname>: Should be able to run a command on a remote host, by setting a

Support for custom shell executable

subprocess.Popen with shell=True runs the program through /bin/sh by default, a behavior that can be overridden with executable=value when creating the object.

Sultan should support this overriding - with a very simple rationale (for me :) - Ubuntu links /bin/sh to /bin/dash (they probably have their good reasons for that), which does not have the source command (it's a bash one).
Thus the src context argument cannot be used, which for python's virtual environments is a bummer.

Can we load source file in the load function

Right now I am loading the context with some source which contains informtion about paths etc.

with Sultan.load(user='puneet', logging=False, hostname="hadoopbox",
                 cwd="/home/user/puneet && source /home/user/puneet/hadoop.env") as s:
    for x in s.hadoop('fs -ls /user/puneet').pipe().sed("-r \"s/ +/ /g\"").pipe().cut("-d\" \" -f8").run():
        print(x)

I think this can be made better by having an optional parameter which loads source while loading the context. Or, maybe it's already there and I am missing something.

Something like this would work great

with Sultan.load(user='puneet', logging=False, hostname="hadoopbox",
                 cwd="/home/user/puneet", source="/home/user/puneet/hadoop.env") as s:
    for x in s.hadoop('fs -ls /user/puneet').pipe().sed("-r \"s/ +/ /g\"").pipe().cut("-d\" \" -f8").run():
        print(x)

FINAL: Release 0.3 Features

FINAL

To Do:

• Python 3 Support

Completed:

• Add support for bash's OR operator

Default value of tracecback in the constructor to be ''

Currently the default value of traceback is None:

def __init__(self, stdout, stderr, traceback=None, rc=None):

And that value is only filled in if there is an exception in Sultan.run(); if the user unaware of that calls Result.print_traceback(), there's a general exception

TypeError: 'NoneType' object is not iterable

, coming from Result.__format_lines()'s iterator over the Result.traceback.

If the default is changed to an empty string, the exception won't occur and print_traceback() will behave like the other two print methods.

should not append semicolon ";" on Windows cmd or Powershell

the semicolon breaks usage of this module on Windows if you have PowerShell or cmd shell, and probably other shells since a trailing ; is not ignored by those shells.

Commands with special characters are not automatically escaped, and therefore, throw an error

This throws an error. We need to escape ( and ) in this example.

s = Sultan()
s.touch("/tmp/foo(bar).txt")

Output everything

I'm using Sultan for an automated installation script internally.

I would always like to see the output. Now I do that like this:

r = s.sh('./configure').run()
print('\n'.join(r.stdout))

But I have a lot of commands. Can I configure that as a constructor parameter or something?

Pydoc

I think the "pydoc" should be filled out with classes and methods in order to provide better documentation for the project. I tried "pydoc sultan" on my local machine but the lack of information there forced me to search out this github page to figure out exactly how to use it in my scripts.

Add background execution

I need in some occasions a background execution of some commands.
With it it would be great to store a pid of such process too

[Improvement] Make the exception dump while invoking run() optional

Hi!

Been using Sultan for a little while now and i've found one part that should be improved.

from api.py -> cmd -> run()

       except Exception as e:
            result = Result(None, commands, self._context, exception=e)
            result.dump_exception()
            if halt_on_nonzero:
                raise e

The dump_exception() should be optional. At the moment i have three instances of Sultan running "inside" each other due to ssh chaining, and as you might understand, the stack dumb turns into a giant mess when a dump is invoked at layer 3 up to layer 1

Errors and Stdout should be better formatted with logging. If an exception happens, we see a traceback, which is useless. The stderr and std