blob: 4b923f140eb39c120807ad9108bcde5e28d51549 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
Metadata-Version: 2.1
Name: EditorConfig
Version: 0.12.4
Summary: EditorConfig File Locator and Interpreter for Python
Home-page: https://editorconfig.org/
Author: EditorConfig Team
License: PSF-2.0
Project-URL: Source Code, https://github.com/editorconfig/editorconfig-core-py
Project-URL: Bug Tracker, https://github.com/editorconfig/editorconfig-core-py/issues
Classifier: License :: OSI Approved :: Python Software Foundation License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: PyPy
License-File: LICENSE.BSD
License-File: LICENSE.PSF
License-File: COPYING
========================
EditorConfig Python Core
========================
.. image:: https://img.shields.io/pypi/v/EditorConfig.svg
:target: https://pypi.python.org/pypi/EditorConfig
.. image:: https://img.shields.io/pypi/wheel/EditorConfig.svg
:target: https://pypi.python.org/pypi/EditorConfig
.. image:: https://img.shields.io/pypi/pyversions/EditorConfig.svg
:target: https://pypi.python.org/pypi/EditorConfig
.. image:: https://secure.travis-ci.org/editorconfig/editorconfig-core-py.svg?branch=master
:target: http://travis-ci.org/editorconfig/editorconfig-core-py
EditorConfig Python Core provides the same functionality as the
`EditorConfig C Core <https://github.com/editorconfig/editorconfig-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 <http://editorconfig.org>`_.
Installation
============
With setuptools::
sudo python setup.py install
Getting Help
============
For help with the EditorConfig core code, please write to our `mailing list
<http://groups.google.com/group/editorconfig>`_. Bugs and feature requests
should be submitted to our `issue tracker
<https://github.com/editorconfig/editorconfig/issues>`_.
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:
.. code-block:: python
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(f"{key}={value}")
For details, please take a look at the `online documentation
<http://pydocs.editorconfig.org>`_.
Running Test Cases
==================
`Cmake <http://www.cmake.org>`_ has to be installed first. Run the test cases
using the following commands::
export PYTHONPATH=$(pwd)
cmake .
ctest .
Use ``-DPYTHON_EXECUTABLE`` to run the tests using an alternative versions of
Python (e.g. Python 3.12)::
cmake -DPYTHON_EXECUTABLE=/usr/bin/python3.12 .
ctest .
License
=======
See COPYING file for licensing details.
|
