Welcome to Swytcher’s documentation!

Contents:

Swytcher

https://img.shields.io/pypi/v/swytcher.svg https://img.shields.io/travis/eddie-dunn/swytcher.svg Documentation Status Updates

Automatically switches your keyboard layout based on your active window.

Are you using multiple keyboard layouts? Have you discovered that the US keyboard layout is a lot more suitable for programming than the layout you have to use when writing email or otherwise communicating in your native language?

Does it annoy you that you need to remember to manually switch between layouts when going from VIM to your chat/email/whatever app?

If so, Swytcher will solve your problems.

Features

  • Switch keyboard layout based on X window class
  • Switch keyboard layout based on X window name

Planned features

  • Switch layout based on combination of window class and name
  • Remember last keyboard layout for each window

Installation

$ pip install --user swytcher

Usage

First, copy the sample configuration:

$ swytcher --cpcfg

Now you can edit ~/.config/swytcher/config.ini and add the window classes/names to the corresponding layout section.

layout_primary maps to your first keyboard layout, and layout_secondary will map to your second. If you have more than two layouts you will have to add more sections to the config file. Each additional layout section must start with layout, and be uniquely named. The order that they have in the config file should map to the order that you have defined your different layouts in.

Once you are done editing your config file, you can start Swytcher, and your keyboard layout will be switched whenever you change focus to a window that corresponds to a window class and/or name in your config file.

Swytcher has been tested with the Gnome Desktop Environmant and the i3 window manager. Since Swytcher looks at your X keyboard config it should work with most DEs and WMs.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install Swytcher, run this command in your terminal:

$ pip install swytcher

This is the preferred method to install Swytcher, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for Swytcher can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/eddie-dunn/swytcher

Or download the tarball:

$ curl  -OL https://github.com/eddie-dunn/swytcher/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use Swytcher in a project:

import swytcher

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/eddie-dunn/swytcher/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

Swytcher could always use more documentation, whether as part of the official Swytcher docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/eddie-dunn/swytcher/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up swytcher for local development.

  1. Fork the swytcher repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/swytcher.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv swytcher
$ cd swytcher/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 swytcher tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.5, 3.6, and for PyPy. Check https://travis-ci.org/eddie-dunn/swytcher/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_swytcher

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.3.0 (2017-09-02)

Added

  • –version to CLI interface.
  • command for copying sample config to user’s confdir.

0.1.0 (2017-03-23)

  • First release on PyPI.

Indices and tables