Merge pull request #32 from SekouDiaoNlp/dev

Prototype of LexItem saving on hard drives.

docs/usage.rst

@@ -3,8 +3,8 @@ Usage
 =====
 
 .. NOTE:: The language of the lexical entries is French.
-    | The cLexical Corpus is based on `Lexique383`_.
-    | Also note that pylexique only works on Python 3.X
+    The cLexical Corpus is based on `Lexique383`_.
+    Also note that pylexique only works on Python 3.X.
 
 
 To use pylexique from the command line:

pylexique/pylexique.py

@@ -5,9 +5,10 @@
 from collections import OrderedDict, defaultdict
 import pkg_resources
 
-from dataclasses import asdict, dataclass, astuple
+from dataclasses import dataclass
 from typing import ClassVar
 from time import time
+from .utils import set_save_folder
 
 _RESOURCE_PACKAGE = __name__
 

pylexique/utils.py

@@ -4,6 +4,21 @@
 from types import FunctionType
 
 
+def set_save_folder(folder):
+    """
+    Sets the folder in which lyrics will be downloaded and saved.
+
+    :param folder: string.
+        Folder path.
+    :return: string.
+        Folder path.
+    """
+    if not folder:
+        folder = os.path.join(os.path.expanduser("~"), 'Documents', 'pylexique')
+    else:
+        folder = os.path.join(folder, 'pylexique')
+    return folder
+
 def attributes(obj):
     disallowed_names = {
       name for name, value in getmembers(type(obj))