githubdata - pypi Package Compare versions

Comparing version 2 to 2.1

.idea/workspace.xml

@@ -7,9 +7,4 @@ <?xml version="1.0" encoding="UTF-8"?>
   <component name="ChangeListManager">
-    <list default="true" id="226ba462-66cb-4247-8e25-d8741d577fb7" name="Changes" comment="">
-      <change beforePath="$PROJECT_DIR$/.idea/githubdata.iml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/githubdata.iml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/misc.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/misc.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/vcs.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/vcs.xml" afterDir="false" />
+    <list default="true" id="226ba462-66cb-4247-8e25-d8741d577fb7" name="Changes" comment="v2.1 - added README.md">
       <change beforePath="$PROJECT_DIR$/pyproject.toml" beforeDir="false" afterPath="$PROJECT_DIR$/pyproject.toml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/githubdata/__init__.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/githubdata/__init__.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/githubdata/main.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/githubdata/main.py" afterDir="false" />
     </list>
@@ -23,2 +18,40 @@ <option name="SHOW_DIALOG" value="false" />
     <option name="myRunOnSave" value="true" />
+    <option name="myAllFileTypesSelected" value="false" />
+    <option name="mySelectedFileTypes">
+      <set>
+        <option value="Angular2Html" />
+        <option value="CSS" />
+        <option value="Chameleon" />
+        <option value="CoffeeScript" />
+        <option value="Cucumber" />
+        <option value="Cython" />
+        <option value="DjangoTemplate" />
+        <option value="EditorConfig" />
+        <option value="HTML" />
+        <option value="HTTP Request" />
+        <option value="Haml" />
+        <option value="Ini" />
+        <option value="JSON" />
+        <option value="JavaScript" />
+        <option value="Jinja2" />
+        <option value="Jupyter" />
+        <option value="Less" />
+        <option value="Properties" />
+        <option value="Puppet" />
+        <option value="Python" />
+        <option value="RNG Compact" />
+        <option value="ReST" />
+        <option value="SCSS" />
+        <option value="SQL" />
+        <option value="Sass" />
+        <option value="Shell Script" />
+        <option value="Stylus" />
+        <option value="TOML" />
+        <option value="TypeScript" />
+        <option value="XHTML" />
+        <option value="XML" />
+        <option value="YAML" />
+        <option value="requirements.txt" />
+      </set>
+    </option>
   </component>
@@ -46,3 +79,4 @@ <component name="Git.Settings">
     "node.js.selected.package.tslint": "(autodetect)",
-    "settings.editor.selected.configurable": "project.propVCSSupport.DirectoryMappings"
+    "nodejs_package_manager_path": "npm",
+    "settings.editor.selected.configurable": "preferences.sourceCode.Python"
   }
@@ -58,4 +92,26 @@ }]]></component>
       <updated>1661095947680</updated>
-      <workItem from="1661095949065" duration="6029000" />
+      <workItem from="1661095949065" duration="9322000" />
     </task>
+    <task id="LOCAL-00001" summary="v2">
+      <created>1661105421499</created>
+      <option name="number" value="00001" />
+      <option name="presentableId" value="LOCAL-00001" />
+      <option name="project" value="LOCAL" />
+      <updated>1661105421499</updated>
+    </task>
+    <task id="LOCAL-00002" summary="v2.1 - added README.md">
+      <created>1661107710580</created>
+      <option name="number" value="00002" />
+      <option name="presentableId" value="LOCAL-00002" />
+      <option name="project" value="LOCAL" />
+      <updated>1661107710580</updated>
+    </task>
+    <task id="LOCAL-00003" summary="v2.1 - added README.md">
+      <created>1661107815408</created>
+      <option name="number" value="00003" />
+      <option name="presentableId" value="LOCAL-00003" />
+      <option name="project" value="LOCAL" />
+      <updated>1661107815408</updated>
+    </task>
+    <option name="localTasksCounter" value="4" />
     <servers />
@@ -81,3 +137,6 @@ </component>
     </ignored-roots>
+    <MESSAGE value="v2" />
+    <MESSAGE value="v2.1 - added README.md" />
+    <option name="LAST_COMMIT_MESSAGE" value="v2.1 - added README.md" />
   </component>
 </project>

PKG-INFO

 Metadata-Version: 2.1
 Name: githubdata
-Version: 2
-Summary: A simple tool to get last version of a github repository and committing back
+Version: 2.1
+Summary: A simple tool to get last/full version of a github repository and committing back to it
 Project-URL: Homepage, https://github.com/imahdimir/githubdata
@@ -50,2 +50,35 @@ Project-URL: Bug Tracker, https://github.com/imahdimir/githubdata/issues
 
-A simple tool to get last version of a github repository and committing back
+A simple tool to get last/full version of a github repository and committing
+back to
+it.
+
+# Quick Start
+
+```python
+from githubdata import GithubDataRepo
+
+
+url = 'https://github.com/imahdimir/d-uniq-BaseTickers'
+
+repo = GithubDataRepo(url)
+repo.clone_overwrite_last_version()
+
+data_suffix = '.xlsx'
+fpns = repo.return_sorted_list_of_fpns_with_the_suffix(data_suffix)
+```
+
+## To delete the directory downloaded:
+
+```python
+repo.rmdir()
+```
+
+# More Details
+
+`repo.clone_overwrite_last_version()`
+
+- Every time excecuted, it re-downloads last version of data.
+
+`repo.return_sorted_list_of_fpns_with_the_suffix('.xlsx')`
+
+- Returns a sorted list containing filepaths downloaded with a given suffix (type).

pyproject.toml

@@ -7,5 +7,5 @@ [build-system]
 name = "githubdata"
-version = "2"
+version = "2.1"
 authors = [{ name = "Mahdi Mir", email = "[e-mail]" }]
-description = "A simple tool to get last version of a github repository and committing back"
+description = "A simple tool to get last/full version of a github repository and committing back to it"
 readme = "README.md"
@@ -12,0 +12,0 @@ license = { file = "LICENSE" }

README.md

@@ -1,1 +0,34 @@
-A simple tool to get last version of a github repository and committing back
+A simple tool to get last/full version of a github repository and committing
+back to
+it.
+
+# Quick Start
+
+```python
+from githubdata import GithubDataRepo
+
+
+url = 'https://github.com/imahdimir/d-uniq-BaseTickers'
+
+repo = GithubDataRepo(url)
+repo.clone_overwrite_last_version()
+
+data_suffix = '.xlsx'
+fpns = repo.return_sorted_list_of_fpns_with_the_suffix(data_suffix)
+```
+
+## To delete the directory downloaded:
+
+```python
+repo.rmdir()
+```
+
+# More Details
+
+`repo.clone_overwrite_last_version()`
+
+- Every time excecuted, it re-downloads last version of data.
+
+`repo.return_sorted_list_of_fpns_with_the_suffix('.xlsx')`
+
+- Returns a sorted list containing filepaths downloaded with a given suffix (type).

src/githubdata/main.py

@@ -1,3 +0,1 @@
-##
-
 import shutil
@@ -89,2 +87,4 @@ from pathlib import Path
     """
+    Every time excecuted, it re-downloads last version of the reposiroty to local_path.
+
     :param depth: None for full depth, default = 1 (last version)
@@ -134,13 +134,2 @@ :return: None
 def build_targurl_with_usr_token(usr , tok , targ_repo) :
-  return f'https://{usr}:{tok}@github.com/{targ_repo}'
-
-##
-# gsrc = 'https://github.com/imahdimir/d-uniq-BaseTickers'
-# btics = GithubDataRepo(gsrc)
-# ##
-# btics.clone_overwrite_last_version()
-# ##
-# fps = btics.return_sorted_list_of_fpns_with_the_suffix('prq')
-# print(fps)
-#
-# ##
+  return f'https://{usr}:{tok}@github.com/{targ_repo}'

Alert delta unavailable

Currently unable to show alert delta for PyPI packages.

Improved metrics

Total package byte prevSize

24291

13.22%

Worsened metrics

Lines of code

92

-9.8%