Updated docs and linting

Author: Abhijeet

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+exclude: 'docs|node_modules|migrations|.git|.tox'
+default_stages: [commit]
+fail_fast: true
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/psf/black
+    rev: 21.7b0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/timothycrosley/isort
+    rev: 5.9.3
+    hooks:
+      - id: isort

AUTHORS.rst

@@ -5,7 +5,7 @@ Credits
 Development Lead
 ----------------
 
-* Abhijeet Pal 
+* Abhijeet Pal
 
 Contributors
 ------------

HISTORY.rst

@@ -6,4 +6,3 @@ History
 ------------------
 
 * First release on PyPI.
- 

LICENSE

@@ -19,4 +19,3 @@ 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.rst

@@ -13,7 +13,7 @@ Lorem Text
 
 
 
-Dummy lorem ipsum text generator 
+Dummy lorem ipsum text generator
 
 
 * Free software: MIT license
@@ -45,7 +45,7 @@ For randomly generated sentence of lorem ipsum text where the first word is capi
 
     lorem.sentence()
 
-Generate a single paragraph:: 
+Generate a single paragraph::
 
     lorem.paragraph()
 
@@ -62,7 +62,7 @@ Generate random lorem ipsum words seperated with single space::
     lorem.words(words)
 
 
-Command Line Interface 
+Command Line Interface
 ----------------------
 
 For randomly generated paragraph of lorem ipsum text::
@@ -71,7 +71,7 @@ For randomly generated paragraph of lorem ipsum text::
 
 Lorem ipsum sentence::
 
-    lorem_text --s 
+    lorem_text --s
 
 Lorem ipsum words::
 

docs/conf.py

@@ -83,7 +83,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.  For a list of options available for each theme, see the

lorem_text/__init__.py

@@ -1,4 +1,4 @@
 """Top-level package for Lorem Text."""
 
 __author__ = """Abhijeet Pal"""
-__version__ = '1.0'
+__version__ = "1.0"

lorem_text/cli.py

@@ -1,13 +1,15 @@
 """Console script for lorem_text."""
-import click
 import sys
+
+import click
+
 from lorem_text import lorem
 
 
 @click.command()
-@click.option('--words', type=int, help="Returns lorem ipsum words")
-@click.option('--s', is_flag=True, help="Returns lorem ipsum sentence")
-def main(words,  s):
+@click.option("--words", type=int, help="Returns lorem ipsum words")
+@click.option("--s", is_flag=True, help="Returns lorem ipsum sentence")
+def main(words, s):
     """Console script for lorem."""
     if words:
         words = int(words)