Minor changes

LICENSE.TXT

@@ -0,0 +1,19 @@
+MIT License
+
+Copyright (c) 2019 Kornel Szurek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -3,11 +3,12 @@
 [![Build Status](https://travis-ci.org/myslak71/flake8-koles.svg?branch=master)](https://travis-ci.org/myslak71/flake8-koles)
 [![Coverage Status](https://coveralls.io/repos/github/myslak71/flake8-koles/badge.svg?branch=master)](https://coveralls.io/github/myslak71/flake8-koles?branch=master)
 ![image](https://img.shields.io/badge/python-3.7-blue.svg)
+![image](https://img.shields.io/badge/version-0.0.1-yellow)
 
 
 Watch your language young pal!
 
-Flake8 extension checking bad language occurences.
+Flake8 extension for checking bad language occurrences.
 
 ## Installation
 ```
@@ -16,8 +17,15 @@ pip install git+https://github.com/myslak71/flake8-koles.git
 
 ## Usage
 ```
-flake8 --ignore-shorties --censor-msg
+flake8 --ignore-shorties 4 --censor-msg
 ```
+`--ignore-shorties <number>` - ignores bad words shorter or equal to `<number>`
+
+
+`--censor-msg` - replaces bad words not leading letters with `*` in error messages
+
+
+
 
 ## Development notes
 `make lint` - runs all linters

flake8_koles/__about__.py

@@ -1,10 +1,10 @@
 """Package information module."""
 
-__title__ = "flake8-koles"
-__description__ = ""
-__version__ = "0.0.1"
-__build__ = 0x022200
-__author__ = "myslak71"
-__author_email__ = "myslak@protonmail.com"
-__license__ = "MIT"
-__copyright__ = "Copyright 2019 myslak71"
+__title__ = 'flake8-koles'
+__description__ = 'Watch your language young lad! Swears nad curses linter'
+__version__ = '0.0.1'
+__author__ = 'myslak71'
+__author_email__ = 'myslak@protonmail.com'
+__url__ = 'https://github.com/myslak71/flake8-koles'
+__license__ = 'MIT'
+__copyright__ = 'Copyright 2019 myslak71'

requirements-dev.txt

@@ -9,12 +9,12 @@ yamllint==1.16.0
 pydocstyle==3.0.0
 
 # Testing purposes
-#######################
+########################
 pytest==5.0.1
 pytest-cov==2.7.1
 # To be used when the repo goes public
 coveralls==1.8.1
 
 # Debugging
-#######################
+########################
 pdbpp==0.10.0

setup.cfg

@@ -1,2 +1,5 @@
+[metadata]
+description-file = README.md
+
 [flake8]
 max-line-length = 90

setup.py

@@ -1,31 +1,47 @@
 """Koles package installation setup."""
 import os
 
-from setuptools import setup, find_packages
+from setuptools import setup
 
-DIR_PATH = os.path.dirname(os.path.abspath(__file__))
+DIR_PATH = os.path.abspath(os.path.dirname(__file__))
 
 install_requires = ['flake8>=1.5', 'six', 'pycodestyle']
 
 with open(os.path.join(DIR_PATH, 'README.md'), encoding='utf-8') as file:
     long_description = file.read()
 
+about = {}
+
+with open(os.path.join(DIR_PATH, 'flake8_koles', '__about__.py'), 'r', encoding='utf-8') as f:
+    exec(f.read(), about)
 
 setup(
-    name='flake8-koles',
-    author='myslak71',
+    name=about['__title__'],
+    description=about['__description__'],
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    version=about['__version__'],
+    author=about['__author__'],
+    author_email=about['__author_email__'],
+    license=about['__license__'],
+    keywords=['linter', 'flake8', 'swears', 'curses'],
     packages=['flake8_koles'],
     package_data={'flake8_koles': ['data/swear_list/*.dat']},
     py_modules=['flake8_koles'],
-    author_email='myslak@protonmail.com ',
-    description='Bad language linter',
-    long_description=long_description,
     python_requires=">=3.7",
     install_requires=install_requires,
     entry_points={
         'flake8.extension': [
             'KOL = flake8_koles.checker:KolesChecker',
         ]
-    }
+    },
 
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'Natural Language :: English',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3.7',
+    ],
 )