Skip to main content

A tool for Google Scholar citation badge generation.

Project description

GoogleScholar Badge Generator

shields.io does not provide an API to help generate citation badges of articles/profiles on Google Scholar. Therefore, I create this repository to build us such a tool. Need citation badges but cannot find a proper tool? Try GSBG! You can even make yourself a GoogleScholar version of shields.io with GitHub actions! Take a look at Usage below.

Please star🌟 this repo to help others notice GSBG if you think it is useful. Thank you!

❖ Installation

You can install GSBG via pip: pip install gsbg, or from the latest source code: pip install https://github.com/WenjieDu/Google_Scholar_Badge_Generator/archive/main.zip.

❖ Usage

Apart from the below examples, you can also integrate GSBG with GitHub workflows to automatically generate badges for your articles/profiles, save them in your repo, and update them periodically. Please take a look at https://github.com/WenjieDu/WenjieDu for an example. The workflow .github/workflows/gene_citation_badges.yml will regularly run the generating script scripts/gene_google_scholar_badges.py to maintain the badges under figs/citation_badges.

You can fork my repo and modify the script and the workflow to fit your own needs. If you meet any question, please raise an issue. I'll try my best to help.

import gsbg

article_link = "https://scholar.google.com/citations?view_op=view_citation&hl=en&user=j9qvUg0AAAAJ&citation_for_view=j9qvUg0AAAAJ:Y0pCki6q_DkC"
profile_link = "https://scholar.google.com/citations?user=j9qvUg0AAAAJ&hl=en"

article_citation_num = gsbg.fetch_article_citation_num(article_link)
profile_citation_num = gsbg.fetch_profile_citation_num(profile_link)
gsbg.gene_citation_badge_link(
    link='https://scholar.google.com/citations?user=j9qvUg0AAAAJ&hl=en', 
    link_type="profile",
)
gsbg.gene_citation_badge_svg(
    link='https://scholar.google.com/citations?user=j9qvUg0AAAAJ&hl=en', 
    link_type="profile",
    svg_name='gsbg.svg',
    path_to_save='generated_badges',
)
🏠 Visits GSBG visits

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gsbg-0.1.3.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

gsbg-0.1.3-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

Details for the file gsbg-0.1.3.tar.gz.

File metadata

  • Download URL: gsbg-0.1.3.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for gsbg-0.1.3.tar.gz
Algorithm Hash digest
SHA256 4847468ed0942be201284fda78ba155d45c811ce6ec4b2e4a25a27728a7b13c2
MD5 162180033020d1f58bcad7c024506a94
BLAKE2b-256 1d6541171bd4830964ac10e3ba8695ef96cf440e887a646fa4628a764fb03b63

See more details on using hashes here.

File details

Details for the file gsbg-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: gsbg-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 19.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for gsbg-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2bd6343dcc83f8757a6e9463f74d32e688c7d5a6aaa50a8addbd038eda57960e
MD5 a29be027ec41bab7466e690923e42e12
BLAKE2b-256 14f965c9674b935cad094a587eb2cdcffa7ae2572f833d2ff3ccbf1e92cee21f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page