Merge pull request #17 from editorconfig-checker/download-exe-setup

Move logic to setup.py

.pre-commit-hooks.yaml

@@ -1,7 +1,7 @@
 -   id: editorconfig-checker
     name: editorconfig-checker
     description: '`editorconfig-checker` is a tool to check if your files consider your .editorconfig-rules.'
-    entry: editorconfig-checker
+    entry: ec
     language: python
     types: [text]
     require_serial: true

Makefile

@@ -1,18 +1,27 @@
 .PHONY: help
 help:
 	@echo "Available targets:"
-	@echo "    - help         : Print this help message."
-	@echo "    - clean        : Remove generated files."
-	@echo "    - coding_style : Run coding style tools."
+	@echo "  - help         : Print this help message."
+	@echo "  - clean        : Remove generated files."
+	@echo "  - coding-style : Run coding style tools."
+	@echo "  - publish	    : Publish package to PyPI."
+	@echo "  - test         : Run coding style tools and tests."
 
 .PHONY: all
 all: help
 
 .PHONY: clean
 clean:
-	@rm -rf build dist editorconfig_checker.egg-info editorconfig_checker/bin
+	rm -rf build dist editorconfig_checker.egg-info editorconfig_checker/bin
 
-.PHONY: coding_style
-coding_style:
-	@pycodestyle --ignore E501 .
-	@flake8 --ignore E501 .
+.PHONY: coding-style
+coding-style:
+	flake8 --ignore E501 setup.py
+
+.PHONY: publish
+publish:
+	bash publish.sh
+
+.PHONY: test
+test: coding-style
+	bash test.sh

README.md

@@ -1,91 +1,35 @@
-# editorconfig-checker
+# editorconfig-checker.python
+A Python wrapper to provide a pip-installable [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker) binary.
 
-![Logo](https://raw.githubusercontent.com/editorconfig-checker/editorconfig-checker.python/master/docs/logo.png "Logo")
+Internally, this package provides a convenient way to download the pre-built `editorconfig-checker` binary for your particular platform.
 
-<a href="https://www.buymeacoffee.com/mstruebing" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
-
-## What?
-
-This is a tool to check if your files consider your `.editorconfig`.
-Most tools - like linters for example - only test one filetype and need an extra configuration.
-This tool only needs your editorconfig to check all files.
-
-![Sample Output](https://raw.githubusercontent.com/editorconfig-checker/editorconfig-checker.python/master/docs/sample-output.png "Sample output")
-
-## Important
-
-This is only a wrapper for the core [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker).
-You should have a look at this repository to know how this tool can be used and what possibilities/caveats are there.
-This version can be used in the same way as the core as every argument is simply passed down to it.
 
 ## Installation
-
 ```
-$ pip install .                     # from cloned repo
+$ pip install .                     # from source code
 $ pip install editorconfig-checker  # from PyPI
 ```
 
+
 ## Usage
+After installation, the `ec` binary should be available in your environment (or `ec.exe` on Windows):
 
 ```
-$ editorconfig-checker -help
-USAGE:
-  -config string
-        config
-  -debug
-        print debugging information
-  -disable-end-of-line
-        disables the trailing whitespace check
-  -disable-indentation
-        disables the indentation check
-  -disable-insert-final-newline
-        disables the final newline check
-  -disable-trim-trailing-whitespace
-        disables the trailing whitespace check
-  -dry-run
-        show which files would be checked
-  -exclude string
-        a regex which files should be excluded from checking - needs to be a valid regular expression
-  -h    print the help
-  -help
-        print the help
-  -ignore-defaults
-        ignore default excludes
-  -init
-        creates an initial configuration
-  -no-color
-        dont print colors
-  -v    print debugging information
-  -verbose
-        print debugging information
-  -version
-        print the version number
+$ ec -version
 ```
 
-## Usage with the pre-commit git hooks framework
 
-editorconfig-checker can be included as a hook for [pre-commit](https://pre-commit.com/). The easiest way to get started is to add this configuration to your `.pre-commit-config.yaml`:
+## Usage with the pre-commit git hooks framework
+`editorconfig-checker` can be included as a hook for [pre-commit](https://pre-commit.com/).
+The easiest way to get started is to add this configuration to your `.pre-commit-config.yaml`:
 
 ```yaml
 repos:
 -   repo: https://github.com/editorconfig-checker/editorconfig-checker.python
     rev: ''  # pick a git hash / tag to point to
     hooks:
     -   id: editorconfig-checker
+        alias: ec
 ```
 
-See the [pre-commit docs](https://pre-commit.com/#pre-commit-configyaml---hooks) for how to customize this configuration.
-
-## Run tests
-
-The test script uses `docker`. After installing it, you can run the test with:
-```
-$ ./test.sh
-```
-
-## Support
-
-If you have any questions or just want to chat join #editorconfig-checker on
-freenode(IRC).
-If you don't have an IRC-client set up you can use the
-[freenode webchat](https://webchat.freenode.net/?channels=editorconfig-checker).
+See the [pre-commit docs](https://pre-commit.com/#pre-commit-configyaml---hooks) to check how to customize this configuration.

dev_requirements.txt

@@ -0,0 +1 @@
+flake8==3.9.1

publish.sh

@@ -2,12 +2,10 @@
 
 set -e
 
-# Run tests
-bash test.sh
-
-# Remove generated files
+# Run tests & cleanup
+make test
 make clean
 
 # Build & publish (currently, we push the package under the username `mmicu_00`)
-python3 setup.py sdist bdist_wheel
+python3 setup.py sdist
 twine upload dist/*

setup.cfg

@@ -0,0 +1,25 @@
+[metadata]
+name = editorconfig-checker
+description = Python wrapper around invoking editorconfig-checker (https://github.com/editorconfig-checker/editorconfig-checker)
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/editorconfig-checker/editorconfig-checker.python
+author = Marco M.
+author_email = [email protected]
+license = MIT
+license_file = LICENSE
+classifiers =
+    Programming Language :: Python
+    Programming Language :: Python :: 2
+    Programming Language :: Python :: 2.7
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3.5
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Topic :: Text Processing
+    Topic :: Utilities
+
+[options]
+python_requires = >=2.7