Skip to main content

EditorConfig File Locator and Interpreter for Python

Project description

https://img.shields.io/pypi/v/EditorConfig.svg https://img.shields.io/pypi/wheel/EditorConfig.svg https://img.shields.io/pypi/pyversions/EditorConfig.svg https://secure.travis-ci.org/editorconfig/editorconfig-core-py.svg?branch=master

EditorConfig Python Core provides the same functionality as the EditorConfig C Core. EditorConfig Python core can be used as a command line program or as an importable library.

EditorConfig Project

EditorConfig makes it easy to maintain the correct coding style when switching between different text editors and between different projects. The EditorConfig project maintains a file format and plugins for various text editors which allow this file format to be read and used by those editors. For information on the file format and supported text editors, see the EditorConfig website.

Installation

With setuptools:

sudo python setup.py install

Getting Help

For help with the EditorConfig core code, please write to our mailing list. Bugs and feature requests should be submitted to our issue tracker.

If you are writing a plugin a language that can import Python libraries, you may want to import and use the EditorConfig Python Core directly.

Using as a Library

Basic example use of EditorConfig Python Core as a library:

from editorconfig import get_properties, EditorConfigError

filename = "/home/zoidberg/humans/anatomy.md"

try:
    options = get_properties(filename)
except EditorConfigError:
    print "Error occurred while getting EditorConfig properties"
else:
    for key, value in options.items():
        print "%s=%s" % (key, value)

For details, please take a look at the online documentation.

Running Test Cases

Cmake has to be installed first. Run the test cases using the following commands:

cmake .
ctest .

Use -DPYTHON_EXECUTABLE to run the tests using an alternative versions of Python (e.g. Python 3):

cmake -DPYTHON_EXECUTABLE=/usr/bin/python3 .
ctest .

License

See COPYING file for licensing details.

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

EditorConfig-0.12.2.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

EditorConfig-0.12.2-py2-none-any.whl (13.4 kB view details)

Uploaded Python 2

File details

Details for the file EditorConfig-0.12.2.tar.gz.

File metadata

File hashes

Hashes for EditorConfig-0.12.2.tar.gz
Algorithm Hash digest
SHA256 1b0ef345f9c3a673e492cfe608ed644b236139f7fceab5c6f513a71bcaf8a56c
MD5 12671d6fbadb20f3b1474d9d32b7fb43
BLAKE2b-256 2e7aaedb7e1cba1778c1d78c4f6ad88d4b0dfca6b991befa248164121091d911

See more details on using hashes here.

File details

Details for the file EditorConfig-0.12.2-py2-none-any.whl.

File metadata

File hashes

Hashes for EditorConfig-0.12.2-py2-none-any.whl
Algorithm Hash digest
SHA256 60d6f10b87d2572ac1581cb8c9f018163e2b13a9e49588f9fb6dc8c715a1744c
MD5 76fdea7162eba69d0d98c500d639405d
BLAKE2b-256 57a62ac764d383137fc73dbc532c9c09f98937d4c2197bb9c4067d747d45a3e1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page