Skip to main content

Tools to convert Sublime Text snippets into Jetbrains live templates and vice versa

Project description

.. image:: https://img.shields.io/pypi/v/shortbus.svg
:target: https://pypi.python.org/pypi/shortbus

.. image:: https://img.shields.io/travis/brmc/shortbus.svg
:target: https://travis-ci.org/brmc/shortbus

.. image:: https://readthedocs.org/projects/shortbus/badge/?version=latest
:target: https://shortbus.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://pyup.io/repos/github/brmc/shortbus/shield.svg
:target: https://pyup.io/repos/github/brmc/shortbus/
:alt: Updates

========
shortbus
========

Tools to convert Sublime Text snippets into Jetbrains live templates and vice versa


* Free software: MIT license
* Documentation: something is wrong with the read-the-docs build, so for those in a *nix environment, to view the documentation do this:

.. code-block:: console

$ git clone https://github.com/brmc/shortbus
$ cd shortbus
$ make docs

a browser should open with the docs

Requirements:
-------------

- python3.6+
- lxml
- pyyaml

Quick Start
-----------

Install library:

.. code-block:: console

$ pip install shortbus

Do stuff:

.. code-block:: python

transpilers.import_from_yml('./my.yml')
.import_from_sublimetext('~/path/to/sublimetext/snippetdir/)
.import_from_jetbrains('~/.PyCharm2016.3/config/liveTemplates/Djaneiro.xml')
.export_to_jetbrains('shortbus.xml')
.export_to_yml('shortbus.yml')

.. include:: ./docs/ymlsyntax.rst



=======
History
=======

0.2.2 (2018-1-4)

* Added name prefix option for template definitions

0.2.1 (2018-1-4)

* Bugfix: Custom template definitions were not properly respecting context definitions

0.2.0 (2017-12-6)
------------------

* Template definitions and transpilers have been made composable with custom
context definitions in order to simplify the YML for people who use languages
other than Python

* Constants for Context option names have been included

0.1.0 (2017-02-12)
------------------

* First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shortbus-0.2.2.tar.gz (26.8 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page