Added descriptions

Author: branbergen

index.py

@@ -1,11 +1,14 @@
+# These classes hold all functionality.
 from src.NameParser.extract import clsExtractNames
 from src.NameParser.generate import clsGenerateNames
 from src.NameParser.parse import clsParseName
 
+# Get your API key on https://parser.name/
 apiKey = "Your-API-Key-Here"
 
 # Initialize the class that parses names.
 name = clsParseName(apiKey)
+
 # Parse a complete name.
 if (name.fromCompleteName("Linus Benedict Torvalds")):
     print(name._gender) #Returns "m".
@@ -29,11 +32,11 @@
     for name in names._list:
         print(name) #Returns five random names.
         details=names.details(name) #Returns all details we have on the generated name.
-        
 
 # Initialize the class that extracts names.
 names = clsExtractNames(apiKey)
 
+# Extract names from text.
 if(names.extract("Veteran quarterback Philip Rivers moved ahead of Matteo Federica on the NFL's all-time passing list.")):
     for name in names._list:
         print(name) #Returns "Philip Rivers" and "Matteo Federica".