Merge 36655d2 into 43163be

CONTRIBUTING.md

@@ -20,13 +20,13 @@ See the merges policy in the topic [Merges to **main**](CONTRIBUTING.md#merges-t
 
 ### **development**
 
-The **development** branch is where the work of the other branches will be unified and where a stable version will be created to merge with **main**.
+The **dev** branch is where the work of the other branches will be unified and where a stable version will be created to merge with **main**.
 Like **main** it is blocked for commits and pushs.
-See the merges policy in the topic [Merges for development] (CONTRIBUTING.md#merges-for-development) merges to **development** </a>.
+See the merges policy in the topic [Merges for dev] (CONTRIBUTING.md#merges-for-development) merges to **dev** </a>.
 
 ### Branch name  
 
-The feature development branches will be created from the **development** branch with the default nomenclature `change_name`.
+The feature development branches will be created from the **dev** branch with the default nomenclature `change_name`.
 
 ## Commits Policy
 
@@ -75,7 +75,7 @@ HOTFIX Updating project contribution guide
 
 ### Pull Requests
 
-Pull requests must be made to the **development** branch following the rules and steps in the topic [**Merges**](CONTRIBUTING.md#merges). In the pull request content there should be a clear description of what was done.
+Pull requests must be made to the **dev** branch following the rules and steps in the topic [**Merges**](CONTRIBUTING.md#merges). In the pull request content there should be a clear description of what was done.
 
 
 #### Work in Progress

README.md

@@ -18,7 +18,7 @@ If you have any questions you can also contact us by creating an issue or by ask
 
 ### Installation
 
-To run the project environment, access our [installation guide](INSTALLATION.md).
+To run the project environment, access our [installation guide](https://dodfminer.readthedocs.io/en/stable/user/install.html).
 
 ### Documentation
 

docs/source/user/usage.rst

@@ -34,19 +34,19 @@ Following are the list of avaiable parameters, their description and the default
 Parameters Table
 ^^^^^^^^^^^^^^^^
 
-+------------------+-----------------------------------------+---------+
-| Argument         | Description                             | Default |
-+==================+=========================================+=========+
-| -sp --save_path  | Folder to output the download DODFs     | ./      |
-+------------------+-----------------------------------------+---------+
-| -sd --start_date | Input the date in either mm/yy or mm-yy | 01/19   |
-+------------------+-----------------------------------------+---------+
-| -ed --end_date   | Input the date in either mm/yy or mm-yy | 01/19   |
-+------------------+-----------------------------------------+---------+
++------------------+---------------------------------------------+---------+
+| Argument         | Description                                 | Default |
++==================+=============================================+=========+
+| -sp --save_path  | Folder to output the download DODFs         | ./      |
++------------------+---------------------------------------------+---------+
+| -sd --start_date | Input the date in either mm/yyyy or mm-yyyy | 01/2019 |
++------------------+---------------------------------------------+---------+
+| -ed --end_date   | Input the date in either mm/yyyy or mm-yyyy | 01/2019 |
++------------------+---------------------------------------------+---------+
 
 Usage Example::
 
-    $ dodfminer downloader -sd 01/03 -ed 12/20
+    $ dodfminer downloader -sd 01/2003 -ed 05/2004
 
 Extractor Module
 ----------------

dodfminer/cli.py

@@ -79,12 +79,12 @@ def _download_parser(self):
                                      default=self.save_path, type=str,
                                      help=help_text)
 
-        help_text = 'Input the date in either mm/yy or mm-yy.'
+        help_text = 'Input the date in either mm/yyyy or mm-yyyy.'
         self.download_parser.add_argument('-sd', '--start_date', dest='start_date',
                                      default=self.def_start_date, type=str,
                                      help=help_text)
 
-        help_text = 'Input the date in either mm/yy or mm-yy.'
+        help_text = 'Input the date in either mm/yyyy or mm-yyyy.'
         self.download_parser.add_argument('-ed', '--end_date', dest='end_date',
                                      default=self.def_end_date, type=str,
                                      help=help_text)

dodfminer/downloader/core.py

@@ -61,7 +61,7 @@ def _string_to_date(self, date):
         elif '-' in date:
             date = datetime.strptime(date, '%m-%Y').date()
         else:
-            msg = 'start_date or end_date must be in format mm/yy or mm-yyyy'
+            msg = 'start_date or end_date must be in format mm/yyyy or mm-yyyy'
             raise Exception(msg)
 
         return date
@@ -181,8 +181,8 @@ def pull(self, start_date, end_date):
         The Pdfs are saved in a folder called "data" inside the project folder.
 
         Args:
-            start_date (str): The start date in format mm/yy.
-            end_date (str): The start date in format mm/yy.
+            start_date (str): The start date in format mm/yyyy.
+            end_date (str): The start date in format mm/yyyy.
 
         Note:
             The name or the path of the save folder are hard coded and can't

requirements.txt

@@ -4,7 +4,7 @@ certifi==2020.4.5.2
 chardet==3.0.4
 idna==2.9
 numpy==1.18.5
-pandas==1.0.4
+pandas==1.3.0
 PyMuPDF==1.17.0
 python-dateutil==2.8.1
 pytz==2020.1