githubdata - pypi Package Compare versions

Comparing version 13.1.0 to 14.0.0

.github/workflows/publish-on-pip.yml

+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

PKG-INFO

 Metadata-Version: 2.1
 Name: githubdata
-Version: 13.1.0
+Version: 14.0.0
 Summary: A simple tool to get the lastest version of a dataset in a Github repository
@@ -62,8 +62,10 @@ Project-URL: Homepage, https://github.com/imahdimir/githubdata
 ```python
-import githubdata as gd
+from githubdata.utils import get_data_fr_github_without_double_clone
 
-github_url = 'https://github.com/imahdimir/d-TSETMC_ID-2-FirmTicker'
-df = gd.get_data_from_github(github_url)
+# Github data repository url
+url = 'https://github.com/imahdimir/d-TSETMC_ID-2-FirmTicker'
+
+df = get_data_fr_github_without_double_clone(url)
 ```
 
-- That is easy as that!
+- Easy as That!

pyproject.toml

@@ -7,3 +7,3 @@ [build-system]
 name = "githubdata"
-version = "13.1.0"
+version = "14.0.0"
 authors = [{ name = "Mahdi Mir", email = "[e-mail]" }]
@@ -10,0 +10,0 @@ description = "A simple tool to get the lastest version of a dataset in a Github repository"

README.md

@@ -10,8 +10,10 @@ # Install
 ```python
-import githubdata as gd
+from githubdata.utils import get_data_fr_github_without_double_clone
 
-github_url = 'https://github.com/imahdimir/d-TSETMC_ID-2-FirmTicker'
-df = gd.get_data_from_github(github_url)
+# Github data repository url
+url = 'https://github.com/imahdimir/d-TSETMC_ID-2-FirmTicker'
+
+df = get_data_fr_github_without_double_clone(url)
 ```
 
-- That is easy as that!
+- Easy as That!

src/githubdata/utils.py

@@ -13,4 +13,4 @@ """
 
-def get_data_from_github_without_double_clone(github_url , remove_cache = False
-                                              ) -> pd.DataFrame :
+def get_data_fr_github_without_double_clone(github_url , remove_cache = False
+                                            ) -> pd.DataFrame :
     """
@@ -21,2 +21,3 @@ gets data from a GitHub data repo, without cloning it twice.
     :param: github_url
+    :remove_cache: if True, it will remove the cloned repo after reading the data.
     :return: pandas.DataFrame
@@ -23,0 +24,0 @@ """

Alert delta unavailable

Currently unable to show alert delta for PyPI packages.

Improved metrics

Total package byte prevSize

14375

9.95%

Number of package files

10

11.11%

Lines of code

129

0.78%