SublimeText configuration for buildout-based Python projects
Project description
Introduction
plone.recipe.sublimetext is the buildout recipe for ST3 lover who wants python IDE like features while developing python Buildout based project. This tool will help them to create per project basis sublimetext settings with appropriate paths location assignment. Currently plone.recipe.sublimetext comes with supporting settings for Anaconda (the all-in-one package), Jedi, Sublimelinter, Sublimelinter-Flake8, Sublimelinter-Pylint. A general question may arise that why we will use this tool, whether we can create ST3 project settings easily (we have better knowledge over ST3 configuration)? Well i completely agree with you, but if you want to get benefited from Anaconda or Jedi’s python autocompletion feature (basically I am lover of autocompletion), you have to add all eggs links for Anaconda or Jedi’s paths settings and it is hard to manage eggs links manually if the size of project is big (think about any Plone powered project), beside Sublimelinter-Pylint also need list of paths to be added to sys.path to find modules.
Installation
Install plone.recipe.sublimetext is simple enough, just need to create a section for sublimetext to your buildout. Before using plone.recipe.sublimetext make sure Jedi, Sublimelinter, Sublimelinter-Flake8 and/or Sublimelinter-Pylint plugins are already installed at your ST3. You could follow full [instruction here] if not your ST3 setup yet. Flake8 linter need flake8 executable available globally (unless you are going to use local flake8), also it is recommended you install some awsome flake8 plugins (flake8-isort, flake8-coding, pep8-naming, flake8-blind-except, flake8-quotes and more could find in pypi)
Example Buildout:
[buildout] parts += sublimetext [sublimetext] recipe = plone.recipe.sublimetext eggs = ${buildout:eggs} jedi-enabled = True sublimelinter-enabled = True sublimelinter-pylint-enabled = True
Available Options
- eggs
Required: Yes
Default: None
Your project’s list of eggs, those are going to be added in path location for Jedi and/or Sublimelinter-Pylint or Anaconda.
- overwrite
Required: No
Default: False
This option indicates whether existing settings should be cleaned first or just updating changes. This situation may happen, you did create settings file manually with other configuration (those are not managed by plone.recipe.sublimetext) and you want keep those settings intact.
- python-executable
Required: No
Default: plone.recipe.sublimetext will find current python executable path.
The python executable path for current project, if you are using virtual environment then should be that python path. FYI: ${home} and ${project} variable should work.
- project-name
Required: No
Default: if you have a existing ST3 project file(settings file) in project/buildout’s root directory, plone.recipe.sublimetext will choose it as project-name, other than project/buildout directory name will become as project-name
Don’t add suffix .sublime-project, when you provide the project name.
- jedi-enabled
Required: No
Default: False
This option is related to enable/disable Sublime Jedi
- jedi-use-omelette
Required: No
Default: False
Use the omelette as basis for jedi autocompletion and go-to-definition. See collective.recipe.omelette
- omelette-location
Required: No
Default: ${buildout:directory}/parts/omelette - the default omelette location.
For use with jedi-use-omelette, but unless the omelette is installed at a custom location, the default should be fine.
- sublimelinter-enabled
Required: No
Default: False
Whether Sublimelinter’s features you want to use or not.
- sublimelinter-pylint-enabled
Required: No
Default: False
If you want to use Sublimelinter-Pylint or not; sublimelinter-enabled option will be respected, means if parent option is set as disabled but you enable this option will not work.
- sublimelinter-pylint-executable
Required: No
Default: ‘’
You could provide buildout specific pylint executable. It is very flexible way to avoid using global pylint. Example of relative path usecase: i.) ${buildout:directory}/bin/pylint ii.) $project_path/bin/pylint iii.) ./bin/pylint iv.) ~/path/bin/pylint
- sublimelinter-pylint-args
Required: No
Default: ‘’
@see bellow at sublimelinter-flake8-args section for full detail.
- sublimelinter-flake8-enabled
Required: No
Default: False
Whether you want to use Sublimelinter-Flake8 or not. Like sublimelinter-pylint-enabled parent option will be respected.
- sublimelinter-flake8-executable
Required: No
Default: ‘’
Project specific Flake8 executable path, this will give you lots flexibility over using global Flake8 executable, because each project might have separate Python version. You could use buildout or user’s relative directory path and it is very convenient for collboration works where all members’ absolute path of flake8 excecutable may not be the same! Example of relative path usecase: i.) ${buildout:directory}/bin/flake8 ii.) $project_path/bin/flake8 iii.) ./bin/flake8 iv.) ~/path/bin/flake8
- sublimelinter-flake8-args
Required: No
Default: ‘’
It is possible to provide arguments (options) for flake8 executable project specific. You have to follow a simple format to provide multiple arguments aka flake8 options thanks to buildout for making our life easy. Format {option name}={option value(optional if the arg boolen type)} max-line-length=90, it is remarkable that -- prefix is not required, you can provide multiple arguments separated by space and/or newline
sublimelinter-flake8-args = max-line-length=90 –show-source
- sublimelinter-flake8-args = max-line-length=90 –show-source
output-file=path_to_file
- anaconda-enabled
Required: No
Default: False
This option is related to whether you want to enable Anaconda the all-in-one python IDE package!
- anaconda-linting-enabled
Required: No
Default: True
If want to other library for liniting (i.e sublimelinter), keep it disabled, other than should be enabled. Like other parent options, it will respect parent (anaconda-enabled) option.
- anaconda-completion-enabled
Required: No
Default: True
Anaconda is using Jedi engine for autocompletion, but if you want to use Sublime-Jedi other than provided by Anaconda, make it disabled.
- anaconda-pylint-enabled
Required: No
Default: False
By default Anaconda liniting doing validation using PyFlakes, PEP8, PEP257. But you can use Pylint instead of PyFlakes by enabling this option.
- anaconda-validate-imports
Required: No
Default: True
It is always good that you want to see any invalid imports (for example: from fake.foo import bar), but if you don’t want this just disabled this option.
- anaconda-pep8-ignores
Required: No
Default: ‘’
If you want ignore some pep8 checklist (i.e N802 is for pep8 naming). Each ignore should be separated by space and/or newline.
- anaconda-pep257-enabled
Required: No
Default: False
Indicates whether you want to active pep257 checklist by anaconda.
- anaconda-pep257-ignores
Required: No
Default: ‘’
If you want ignore some pep8 checklist (i.e N802 is for pep8 naming). Each ignore should be separated by space and/or newline.
- ignore-develop
Required: No
Default: False
If you don’t want development eggs, should go for autocompletion.
- ignores
Required: No
Default: “”
If you want specific eggs should not go for autocompletion.
- packages
Required: No
Default: “”
Location of some python scripts or non standard modules (don’t have setup file), you want to be in system path.
Links
Code repository:
Continuous Integration:
Issue Tracker:
https://github.com/collective/plone.recipe.sublimetext/issues
Known Issues
Sublimelinter-Flake8 might stop working if flake8-plone-api is installed as until 1.2 version, flake8-plone-api don’t support SublimeText (linting), see pull request here . That means upcoming version will support hopefully. It could happen, either you are using global or virtualenv flake8. You can see error in ST3 console:
flake8_plone_api-1.2-py2.7.egg/flake8_plone_api.py", line 16, in run with open(self.filename) as f: IOError: [Errno 2] No such file or directory: 'stdin'
Example Usage
- Minimal buildout::
>>> write('buildout.cfg', ... """ ... [buildout] ... develop = . ... eggs = ... zc.buildout ... parts = sublimetext ... ... [sublimetext] ... recipe = plone.recipe.sublimetext ... project-name = plone-recipe-sublime ... eggs = ${buildout:eggs} ... jedi-enabled = True ... """) >>> system(buildout + ' -c buildout.cfg') >>> import os >>> os.path.exists('plone-recipe-sublime.sublime-project') True
Standard buildout:
>>> write('buildout.cfg',
... """
... [buildout]
... develop = .
... eggs =
... zc.buildout
... parts = sublimetext
...
... [sublimetext]
... recipe = plone.recipe.sublimetext
... project-name = plone-recipe-sublime
... eggs = ${buildout:eggs}
... jedi-enabled = True
... sublimelinter-enabled = True
... sublimelinter-flake8-enabled = True
... sublimelinter-flake8-executable = ${buildout:directory}/bin/flake8
... """)
>>> system(buildout + ' -c buildout.cfg')
>>> import json
>>> settings = json.loads(read('plone-recipe-sublime.sublime-project'))
>>> 'Sublimelinter.linters.flake8.enable' in settings['settings']
True
Muilti linters and without project name:
>>> write('buildout.cfg',
... """
... [buildout]
... develop = .
... eggs =
... zc.buildout
... parts = sublimetext
...
... [sublimetext]
... recipe = plone.recipe.sublimetext
... eggs = ${buildout:eggs}
... jedi-enabled = True
... sublimelinter-enabled = True
... sublimelinter-flake8-enabled = True
... sublimelinter-flake8-executable = ${buildout:directory}/bin/flake8
... sublimelinter-pylint-enabled = True
... """)
>>> system(buildout + ' -c buildout.cfg')
(project filename should be plone-recipe-sublime.sublime-project as previously generated):
>>> settings = json.loads(read('plone-recipe-sublime.sublime-project'))
>>> 'pylint' in settings['Sublimelinter']['linters']
True
Usages Anaconda for all purpose (linting, autocompletion) and rest of all are not used:
>>> write('buildout.cfg',
... """
... [buildout]
... develop = .
... eggs =
... zc.buildout
... parts = sublimetext
...
... [sublimetext]
... recipe = plone.recipe.sublimetext
... project-name = plone-recipe-sublime
... eggs = ${buildout:eggs}
... anaconda-enabled = True
... anaconda-pep8-ignores =
... N802
... """)
>>> system(buildout + ' -c buildout.cfg')
>>> import json
>>> settings = json.loads(read('plone-recipe-sublime.sublime-project'))
>>> 'build_systems' in settings.keys()
True
>>> 'extra_paths' in settings['settings'].keys()
True
>>> settings['settings']['anaconda_linting']
True
>>> settings['settings']['use_pylint']
False
Flake8 linter with flake8 arguments:
>>> write('buildout.cfg',
... """
... [buildout]
... develop = .
... eggs =
... zc.buildout
... parts = sublimetext
...
... [sublimetext]
... recipe = plone.recipe.sublimetext
... project-name = plone-recipe-sublime
... eggs = ${buildout:eggs}
... jedi-enabled = True
... sublimelinter-enabled = True
... sublimelinter-flake8-enabled = True
... sublimelinter-flake8-executable = ${buildout:directory}/bin/flake8
... sublimelinter-flake8-args = max-complexity=10 max-line-length=119
... exclude=docs,*.egg.,omelette
... """)
>>> system(buildout + ' -c buildout.cfg')
(project filename should be plone-recipe-sublime.sublime-project):
>>> settings = json.loads(read('plone-recipe-sublime.sublime-project'))
>>> len(settings['settings']['Sublimelinter.linters.flake8.args']) == 3
True
Contributors
Md Nazrul Islam<email2nazrul@gmail.com>, Original Author
Sune Brøndum Wøller [sunew]
Changelog
1.3.0 (2019-02-04)
New features:
SublimeLinter linter arguments are possible to provide linter specific options. Currently sublimelinter-flake8 and sublimelinter-pylint are supported.
New style SublimeLinter linter settings generation has been added. [nazrulworld]
More options (anaconda-pep257-enabled, anaconda-pep257-ignores) added for Anaconda settings.
1.2.0 (2018-03-05)
New features:
(breaking) SublimeLinter 4.x version support is added, that means older than version 4 might not working (although not tested.). If you face any problem, we suggest either you will update SublimeLinter version or use older version of plone.recipe.sublimetext (1.1.6)
pylint executable path now can be provided.
1.1.6 (2018-01-24)
Set a default folder_exclude_patterns for performance, and also to eliminate noise when looking up packages.
Set follow_symlinks to true.
split out omelette in own project folder setting, for being able to exclude ‘parts’. [sunew]
1.1.5 (2017-10-31)
Flake8 executable path: Enable to use buildout relative/user’s home relative path. Means now it is possible to use buildout, sublimetext style relative path. [nazrulworld]
1.1.4 (2017-08-11)
Enable using the omelette as a basis for jedi. [sunew]
1.1.3 (2017-07-30)
Repository ownership transfered to Plone Collective
1.1.2 (2017-07-02)
Bugfixes:
1.1.1 (2017-06-20)
Bugfixes:
[#7]`python_interpreter` value as list but expected as string. [nazrulworld]
1.1.0 (2017-06-07)
New features:
[#4] Anaconda support [nazrulworld]
1.0.1 (2017-05-16)
Bugfixes:
1.0.0 (2017-05-15)
Initial release. [nazrulworld]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for plone.recipe.sublimetext-1.3.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5136a6c5a3dc62a57db99d0ac300ebb98ac1b1a36381769a1f312ee2022d2e2a |
|
| MD5 | 7997b23c0c004e0d6995af9699037a98 |
|
| BLAKE2b-256 | 6b3efb9abb1e6a0c18266c1b48feefe92b22bde6586897da3159dfd8718320e3 |
