Merge pull request #416 from b-ryan/develop

Develop

Author: b-ryan

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changes
 
+Unreleased (version 0.6.0)
+
+* Support for custom themes
+* New option for the `time` segment to specify format of the displayed time
+  ([@dundalek](https://github.com/b-ryan/powerline-shell/pull/383))
+
 2018-04-22 (version 0.5.4)
 
 * Reverted fix for

README.md

@@ -98,7 +98,7 @@ python setup.py install
 
 ### Bash
 
-Add the following to your `.bashrc` (or `.profile` on Mac):
+Add the following to your `.bashrc` file:
 
 ```
 function _update_ps1() {
@@ -110,6 +110,8 @@ if [[ $TERM != linux && ! $PROMPT_COMMAND =~ _update_ps1 ]]; then
 fi
 ```
 
+**Note:** On macOS, you must add this to one of `.bash_profile`, `.bash_login`, or `.profile`. macOS will execute the files in the aforementioned order and will stop execution at the first file it finds. For more information on the order of precedence, see the section **INVOCATION** in `man bash`.
+
 ### ZSH
 
 Add the following to your `.zshrc`:
@@ -171,40 +173,33 @@ powerline-shell --generate-config > ~/.config/powerline-shell/config.json
 
 Once you have generated your config file, you can now start adding or removing
 "segments" - the building blocks of your shell. The list of segments available
-are:
-
-- `aws_profile` - Show which AWS profile is in use. See the
-  [AWS](http://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html)
-  documentation.
-- `battery` - See percentage of battery charged and an icon when the battery is
-  charging.
-- `bzr` - Details about the current Bazaar repo.
-- `cwd` - Shows your current working directory. See [Segment
-  Configuration](#segment-configuration) for some options.
-- `exit_code` - When the previous command ends in a non-zero status, shows the
-  value of the exit status in red.
-- `fossil` - Details about the current Fossil repo.
-- `git` - Details about the current Git repo.
-- `git_stash` - Number of stashes in the current Git repo.
-- `hg` - Details about the current Mercurial repo.
-- `hostname` - Current machine's hostname.
-- `jobs` - Number of background jobs currently running.
-- `newline` - Inserts a newline into the prompt.
-- `node_version` - `node --version`
-- `npm_version` - `npm --version`
-- `php_version` - Version of php on the machine.
-- `rbenv` - `rbenv local`
-- `read_only` - Shows a lock icon if the current directory is read-only.
-- `root` - Shows a `#` if logged in as root, `$` otherwise.
-- `ruby_version` - `ruby --version`
-- `set_term_title` - If able, sets the title of your terminal to include some
-  useful info.
-- `ssh` - If logged into over SSH, shows a network icon.
-- `svn` - Details about the current SVN repo.
-- `time` - Shows the current time.
-- `uptime` - Uptime of the current machine.
-- `username` - Name of the logged-in user.
-- `virtual_env` - Shows the name of the current virtual env or conda env.
+can be seen
+[here](https://github.com/b-ryan/powerline-shell/tree/master/powerline_shell/segments).
+
+You can also create custom segments. Start by copying an existing segment like
+[this](https://github.com/b-ryan/powerline-shell/blob/master/powerline_shell/segments/aws_profile.py).
+Make sure to change any relative imports to absolute imports. Ie. change things
+like:
+
+```python
+from ..utils import BasicSegment
+```
+
+to
+
+```python
+from powerline_shell.utils import BasicSegment
+```
+
+Then change the `add_to_powerline` function to do what you want. You can then
+use this segment in your configuration by putting the path to your segment in
+the segments section, like:
+
+```json
+"segments": [
+    "~/path/to/segment.py"
+]
+```
 
 ### Segment Separator
 
@@ -289,6 +284,10 @@ The options for the `battery` segment are:
 - `always_show_percentage`: If true, show percentage when fully charged on AC.
 - `low_threshold`: Threshold percentage for low-battery indicator color.
 
+The options for the `time` segment are:
+
+- `format`: Format string as used by strftime function, e.g. `%H:%M`.
+
 ### Contributing new types of segments
 
 The `powerline_shell/segments` directory contains python scripts which are

powerline_shell/__init__.py

@@ -167,21 +167,26 @@ def find_config():
 }
 
 
-class ThemeNotFoundException(Exception):
+class ModuleNotFoundException(Exception):
     pass
 
 
-def read_theme(config):
-    theme_name = config.get("theme", "default")
-    try:
-        mod = importlib.import_module("powerline_shell.themes." + theme_name)
-    except ImportError:
+class CustomImporter(object):
+    def __init__(self):
+        self.file_import_count = 0
+
+    def import_(self, module_prefix, module_or_file, description):
         try:
-            mod = import_file("custom_theme", os.path.expanduser(theme_name))
+            mod = importlib.import_module(module_prefix + module_or_file)
         except ImportError:
-            raise ThemeNotFoundException(
-                "Theme " + theme_name + " cannot be found")
-    return getattr(mod, "Color")
+            try:
+                module_name = "_custom_mod_{0}".format(self.file_import_count)
+                mod = import_file(module_name, os.path.expanduser(module_or_file))
+                self.file_import_count += 1
+            except (ImportError, IOError):
+                msg = "{0} {1} cannot be found".format(description, module_or_file)
+                raise ModuleNotFoundException( msg)
+        return mod
 
 
 def main():
@@ -211,13 +216,21 @@ def main():
     else:
         config = DEFAULT_CONFIG
 
-    theme = read_theme(config)
+    custom_importer = CustomImporter()
+    theme_mod = custom_importer.import_(
+        "powerline_shell.themes.",
+        config.get("theme", "default"),
+        "Theme")
+    theme = getattr(theme_mod, "Color")
 
     powerline = Powerline(args, config, theme)
     segments = []
     for seg_name in config["segments"]:
-        mod = importlib.import_module("powerline_shell.segments." + seg_name)
-        segment = getattr(mod, "Segment")(powerline)
+        seg_mod = custom_importer.import_(
+            "powerline_shell.segments.",
+            seg_name,
+            "Segment")
+        segment = getattr(seg_mod, "Segment")(powerline)
         segment.start()
         segments.append(segment)
     for segment in segments:

powerline_shell/segments/time.py

@@ -6,7 +6,10 @@
 class Segment(BasicSegment):
     def add_to_powerline(self):
         powerline = self.powerline
-        if powerline.args.shell == 'bash':
+        format = powerline.segment_conf('time', 'format')
+        if format:
+            time_ = ' %s ' % time.strftime(format)
+        elif powerline.args.shell == 'bash':
             time_ = ' \\t '
         elif powerline.args.shell == 'zsh':
             time_ = ' %* '

setup.py

@@ -3,7 +3,7 @@
 
 setup(
     name="powerline-shell",
-    version="0.5.4",
+    version="0.6.0",
     description="A pretty prompt for your shell",
     author="Buck Ryan",
     author_email="buck@buckryan.com",