citation-map 0.1__py3-none-any.whl

citation_map/__init__.py

@@ -0,0 +1,4 @@
+from .citation_map import citation_map_from_google_scholar_id
+
+__all__ = ['citation_map_from_google_scholar_id']
+

citation_map/citation_map.py

@@ -0,0 +1,109 @@
+from scholarly import scholarly, ProxyGenerator
+from geopy.geocoders import Nominatim
+import folium
+from tqdm import tqdm
+import random
+
+
+def __fetch_google_scholar_profile(scholar_id):
+    '''
+    Step 1: Fetch Google Scholar Profile using Scholar ID
+    '''
+    author = scholarly.search_author_id(scholar_id)
+    author = scholarly.fill(author, sections=["publications"])
+    return author
+
+def __parse_profile(author):
+    '''
+    Step 2: Parse the Profile and find citing author affiliations.
+    Without parallel processing.
+    '''
+    citation_locations = []
+    for pub in tqdm(author['publications']):
+        pub = scholarly.fill(pub)
+        if 'citedby_url' in pub:
+            citing_paper_obj = scholarly.citedby(pub)
+            citing_paper_list = [item for item in citing_paper_obj]
+            for citing_paper in tqdm(citing_paper_list):
+                if 'author_id' in citing_paper:
+                    author_id_list = citing_paper['author_id']
+                    author_id_list = [item for item in author_id_list if item]  # Filter out empty author ids.
+
+                    for author_id in author_id_list:
+                        citing_author = scholarly.search_author_id(author_id)
+                        citing_author = scholarly.fill(citing_author)
+                        if 'affiliation' in citing_author:
+                            citation_locations.append(citing_author['affiliation'])
+    return citation_locations
+
+def __geocode_locations(locations):
+    '''
+    Step 3: Convert locations in plain text to Geocode.
+    '''
+    geolocator = Nominatim(user_agent="citation_mapper")
+    coordinates = []
+    for location in locations:
+        try:
+            geo_location = geolocator.geocode(location)
+            if geo_location:
+                coordinates.append((geo_location.latitude, geo_location.longitude, location))
+        except Exception as e:
+            print(f"Error geocoding location {location}: {e}")
+    return coordinates
+
+def __create_map(coordinates):
+    '''
+    Step 4: Create the Map.
+    '''
+    # citation_map = folium.Map(location=[20, 0], zoom_start=2)
+    # for lat, lon, location in coordinates:
+    #     folium.Marker([lat, lon], popup=location).add_to(citation_map)
+    # return citation_map
+    citation_map = folium.Map(location=[20, 0], zoom_start=2)
+    colors = ['red', 'blue', 'green', 'purple', 'orange', 'darkred',
+              'lightred', 'beige', 'darkblue', 'darkgreen', 'cadetblue',
+              'darkpurple', 'white', 'pink', 'lightblue', 'lightgreen',
+              'gray', 'black', 'lightgray']
+    for lat, lon, location in coordinates:
+        color = random.choice(colors)
+        folium.Marker([lat, lon], popup=location, icon=folium.Icon(color=color)).add_to(citation_map)
+    return citation_map
+
+def citation_map_from_google_scholar_id(scholar_id: str,
+                                        use_proxy: bool = False):
+    '''
+    Google Scholar Citation World Map.
+
+    ----
+    scholar_id: str
+        Your Google Scholar ID.
+    use_proxy: bool
+        If true, we will use a scholarly proxy.
+        It is necessary for some environments to avoid blocks, but it usually makes things slower.
+
+    '''
+
+    if use_proxy:
+        pg = ProxyGenerator()
+        pg.FreeProxies()
+        scholarly.use_proxy(pg)
+        print('Proxy used.')
+
+    author = __fetch_google_scholar_profile(scholar_id)
+    print('Author profile found, with %d publications.' % len(author['publications']))
+
+    locations = __parse_profile(author)
+    print('A total of %d citation locations recorded.' % len(locations))
+
+    coordinates = __geocode_locations(locations)
+    print('Converted the locations to Geocodes.')
+
+    citation_map = __create_map(coordinates)
+    citation_map.save('citation_map.html')
+    print("Map created and saved as citation_map.html")
+
+
+if __name__ == "__main__":
+    # Replace this with your Google Scholar ID.
+    scholar_id = "3rDjnykAAAAJ"
+    citation_map_from_google_scholar_id(scholar_id, use_proxy=False)

citation_map-0.1.dist-info/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 Chen Liu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

citation_map-0.1.dist-info/METADATA

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: citation-map
+Version: 0.1
+Summary: Google Scholar Citation World Map.
+Home-page: https://github.com/ChenLiu-1996/CitationMap
+Author: Chen Liu
+Author-email: chen.liu.cl2482@yale.edu
+License: MIT
+Keywords: citation map,citation world map,google scholar
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: scholarly
+Requires-Dist: geopy
+Requires-Dist: folium
+Requires-Dist: tqdm
+
+# Google Scholar Citation World Map
+
+Chen Liu, CS PhD Candidate at Yale University
+
+## Purpose
+This is a simple Python tool to generate a HTML citation world map from your Google Scholar ID.
+
+## Warning
+1. This script is a bit slow. On my personal computer, it takes half a minute to process each citation. If you have thousands of citations, it may or may not be a good idea to use this script.
+2. I tried to use multiprocessing, but unfortunately the excessive visits get me blocked by Google Scholar.
+
+## Demo
+<img src = "assets/citation_world_map.png" width=800>
+
+## Usage
+1. Install the package.
+```
+pip install citation-map
+```
+
+2. Find your Google Scholar ID.
+
+    On your Google Scholar profile, the string `GOOGLE_SCHOLAR_ID` in the URL `https://scholar.google.com/citations?user=GOOGLE_SCHOLAR_ID` be will be your Google Scholar ID. Ignore the configuration strings such as `&hl=en` or `&view_op=list_works&sortby=pubdate`.
+
+3. In an empty Python script, run the following.
+```
+from citation_map import citation_map_from_google_scholar_id
+
+# This is my Google Scholar ID. Replace this with your ID.
+scholar_id = "3rDjnykAAAAJ"
+citation_map_from_google_scholar_id(scholar_id)
+```
+
+## Dependencies
+```
+scholarly
+geopy
+folium
+tqdm
+```
+
+## Acknowledgements
+This script was written under the help of ChatGPT-4o, but of course after intense debugging.

citation_map-0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+citation_map/__init__.py,sha256=UV_aXSLrG1_Z9zkpi-33lRUD_vAYK41Xyw0-eLhGo6A,114
+citation_map/citation_map.py,sha256=HPcUIbMsk4HMdImI_sR9FRcdboqHcFmcaAXZH1dHJMQ,4018
+citation_map-0.1.dist-info/LICENSE.md,sha256=YGeonFrqqLD4xJdyAvTjAiKRBNdk75E9UCz84L9_3Qk,1064
+citation_map-0.1.dist-info/METADATA,sha256=_z2i2-evgl-5nNaEq3j-HwmXUIQEOPGuo2nAIn9MKJE,1976
+citation_map-0.1.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+citation_map-0.1.dist-info/top_level.txt,sha256=FE-lf7CtT596XdV0sWRFY8xxodQ0Bwi2UDQFRMnuFRI,13
+citation_map-0.1.dist-info/RECORD,,

citation_map-0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.41.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

citation_map-0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+citation_map