Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README.txt file and use PSF license for all
- Loading branch information
1 parent
06ebad6
commit 235503d
Showing
4 changed files
with
79 additions
and
5 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,38 @@ | |||
======================== | |||
EditorConfig Python Core | |||
======================== | |||
|
|||
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. | |||
|
|||
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>`_. | |||
|
|||
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 | |||
================== | |||
|
|||
Example use of EditorConfig Python Core as a library: | |||
|
|||
filename = "/home/zoidberg/myfile.txt" | |||
conf_file = ".editorconfig" | |||
handler = EditorConfigHandler(filename, conf_filename) | |||
options = handler.get_configurations() | |||
for key, value in options.items(): | |||
print "%s=%s" % (key, value) | |||
|
|||
License | |||
======= | |||
|
|||
Unless otherwise stated, all files are distributed under the PSF license. The odict library (editorconfig/odict.py) is distributed under the New BSD license. See LICENSE.txt file for details on PSF license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters