معرفی شرکت ها
bibliometrics-2.3.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Summarize your Google Scholar bibliometrics in an SVG
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | bibliometrics-2.3.0 |
| نام | bibliometrics |
| نسخه کتابخانه | 2.3.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | - |
| ایمیل نویسنده | "Vincent A. Cicirello" <development@cicirello.org> |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/bibliometrics/ |
| مجوز | - |
# bibliometrics
| __Packages and Releases__ | [](https://pypi.org/project/bibliometrics/) [](https://github.com/cicirello/bibliometrics/releases) |
| :--- | :--- |
| __Build Status__ | [](https://github.com/cicirello/bibliometrics/actions/workflows/build.yml) [](https://github.com/cicirello/bibliometrics/actions/workflows/codeql-analysis.yml) |
| __Security__ | [](https://snyk.io/vuln/pip%3Abibliometrics) |
| __Source Info__ | [](https://github.com/cicirello/bibliometrics/blob/main/LICENSE) [](https://github.com/cicirello/bibliometrics) |
| __Support__ | [](https://github.com/sponsors/cicirello) [](https://liberapay.com/cicirello) [](https://ko-fi.com/cicirello) |
This command line utility does the following:
* retrieves the first page of your Google Scholar profile;
* parses from that page your total citations, your five-year citation count, your h-index, your i10-index, and the number of citations of your most-cited paper;
* computes your g-index provided if it is less than 100 ([reason for limitation later](#respect-google-scholars-robotstxt));
* computes your i100-index, i1000-index, and i10000-index ([doi:10.1007/s11192-020-03831-9](https://doi.org/10.1007/s11192-020-03831-9)), hiding any that are 0, and provided they are less than 100 ([reason for limitation later](#respect-google-scholars-robotstxt));
* computes your e-index ([https://doi.org/10.1371/journal.pone.0005429](https://doi.org/10.1371/journal.pone.0005429)) provided that your h-index is at most 100 ([reason for limitation later](#respect-google-scholars-robotstxt));
* generates a JSON file summarizing these bibliometrics;
* generates one or more SVG images summarizing these bibliometrics; and
* includes all bibliometrics that are non-zero by default, but enables user-configurable list of bibliometrics.
The intention of this utility is as a tool for a researcher to generate an SVG of their own
bibliometrics only. For example, I am using it to generate and update such an SVG for my own
profile twice monthly. It is not intended for analyzing multiple researchers' bibliometrics,
and requests for such functionality will be rejected (there are other tools for that).
__Blog Post:__ [Your Citation Metrics in an SVG for Your Website](https://dev.to/cicirello/your-citation-metrics-in-an-svg-for-your-website-17bp) (Posted on DEV.to on July 22, 2022)
## Table of Contents
This README is organized as follows:
* [Samples](#samples): provides examples of the output of this utility.
* [Configuration](#configuration): explains how to configure the utility, such as colors for the SVG,
file locations, etc.
* [Configuring the Scholar ID](#configuring-the-scholar-id): explains the two ways of providing your
Google Scholar ID to the utility.
* [Usage](#usage): how to install and run.
* [Respect Google Scholar's robots.txt](#respect-google-scholars-robotstxt): explains the relevant
portions of Google Scholar's robots.txt as it relates to this, or any tool, designed to gather information
from Scholar. Note that most other tools that provide more functionality (e.g., all of the ones I looked at before
implementing this) do not respect that robots.txt. If you wish to submit an issue or pull request requesting
additional functionality, please know that any such request must be possible to implement without violating
Scholar's robots.txt. Otherwise, the issue or pull request will be closed.
* [Support the Project](#support-the-project): different ways that you can support the project.
* [Contribute](#contribute): contribution guidelines.
* [License](#license).
## Samples
Here are a couple sample SVGs.
Here is a sample of the JSON summary also generated by the utility:
```JSON
{
"e": "34.12",
"fiveYear": 364,
"g": 44,
"h": 25,
"i10": 33,
"i100": 3,
"most": 228,
"total": 2052
}
```
The above sample is also found in this
repository: [bibliometrics.json](https://github.com/cicirello/bibliometrics/blob/main/bibliometrics.json),
and the sample SVGs are found in the [images](https://github.com/cicirello/bibliometrics/blob/main/images) directory.
## Configuration
The utility looks for a configuration file `.bibliometrics.config.json` in your current
working directory (please note the `.` at the start of the filename). A sample is found
at the root of this repository: [.bibliometrics.config.json](https://github.com/cicirello/bibliometrics/blob/main/.bibliometrics.config.json).
To generate the JSON summary of your bibliometrics, specify the filename (optionally with path)
via the `"jsonOutputFile"` field. If this field is not present, then no JSON file will be generated.
To change the order that the bibliometrics appear in the SVG, or to explicitly exclude one or more
bibliometrics, you can use the `"include"` field. This field is an array of keys associated with the
various bibliometrics. If this field is not present, then the following default order is
used: `[ "total", "fiveYear", "most", "h", "g", "i10", "i100", "i1000", "i10000", "e" ]`. There is no
reason to use this field if the only thing you want to do is to exclude bibliometrics that have the
value 0. Such bibliometrics will be excluded by default.
The `"svgConfig"` field is an array of JSON objects, such that each object configures one SVG. Each
of the JSON objects in this array includes the following fields:
* `"filename"` is the filename (optionally with path) to the target SVG file.
* `"background"` is the background color.
* `"border"` is the border color.
* `"title"` is the title color.
* `"text"` is the color of the rest of the text.
* `"include"` is similar to the top-level field of the same name, but applies only to one SVG, whereas the top-level field applies to all. If both the top-level `"include"` field and the more specific field by the same name are used, then the top-level `"include"` overrides the default, and the individual SVG's `"include"` in turn overrides the top-level `"include"`.
The colors can be defined in any format that is valid within an SVG. For example, you can specify
RGB, two hex digits for each color channel, with `#010409`; or RGB with one hex digit for each color
channel, `#123`. You can also use SVG named colors, such as `white`, as well as RGBA such as
`rgba(56,139,253,0.4)`. If it is valid as a color in SVG, then it should work. The utility simply inserts
it for the relevant color within the SVG without validation.
Here is a sample `.bibliometrics.config.json` (using the default order of the bibliometrics):
```JSON
{
"jsonOutputFile": "bibliometrics.json",
"svgConfig": [
{
"background": "#010409",
"border": "rgba(56,139,253,0.4)",
"filename": "images/bibliometrics2.svg",
"text": "#c9d1d9",
"title": "#58a6ff"
},
{
"background": "#f6f8fa",
"border": "rgba(84,174,255,0.4)",
"filename": "images/bibliometrics.svg",
"text": "#24292f",
"title": "#0969da"
}
]
}
```
Here is another sample that generates three SVGs, overriding the default order at the top-level to exclude the
i10-index (and related indexes), and then overriding it again for one of the three SVGs to additionally exclude
the g-index and e-index:
```JSON
{
"jsonOutputFile": "bibliometrics.json",
"include": ["total", "fiveYear", "most", "h", "g", "e"],
"svgConfig": [
{
"background": "#010409",
"border": "rgba(56,139,253,0.4)",
"filename": "images/bibliometrics3.svg",
"text": "#c9d1d9",
"title": "#58a6ff"
},
{
"background": "#010409",
"border": "rgba(56,139,253,0.4)",
"filename": "images/bibliometrics2.svg",
"text": "#c9d1d9",
"title": "#58a6ff",
"include": ["total", "fiveYear", "most", "h"]
},
{
"background": "#f6f8fa",
"border": "rgba(84,174,255,0.4)",
"filename": "images/bibliometrics.svg",
"text": "#24292f",
"title": "#0969da"
}
]
}
```
## Configuring the Scholar ID
There are two ways to provide your Google Scholar ID to the utility:
* in the configuration file (see above section) via a field `"scholarID"` (not shown in the example in the
repository); or
* via an environment variable `SCHOLAR_ID`.
## Usage
### Installing
To install from PyPi (Unix and MacOS):
```Shell
python3 -m pip install bibliometrics
```
To install from PyPI (Windows):
```Shell
py -m pip install bibliometrics
```
To upgrade to latest version from PyPi (Unix and MacOS):
```Shell
python3 -m pip install --upgrade bibliometrics
```
To upgrade to latest version from PyPI (Windows):
```Shell
py -m pip install --upgrade bibliometrics
```
### Running
To use this utility, first ensure that you configure it as specified above. Then execute the following (Unix and MacOS):
```Shell
python3 -m bibliometrics
```
Or on Windows:
```Shell
py -m bibliometrics
```
## Respect Google Scholar's robots.txt
If you use this utility, please respect Google Scholar's robots.txt. The reason that the
g-index (as well as i100-index, i1000-index, i10000-index) is only computed by this utility
if it is less than 100 derives from Scholar's robots.txt. Likewise, the reason that the
e-index is only computed if your h-index is at most 100 relates to this as well. Here is the
relevant excerpt:
```robots.txt
Allow: /citations?user=
Disallow: /citations?*cstart=
```
The first line above allows getting a user's profile page. But the second line
above disallows querying a specific starting reference. This means if you are respecting
Google Scholar's robots.txt then you are limited to the first page of the profile, which
can include up to 100 publications. Therefore, we can compute g-index as long as it is not
greater than 100. However, if we compute 100, we cannot be certain if it is correct or if
it is actually higher, so this utility excludes a g-index of 100 as well. The same is true
for i100-index, i1000-index, and i10000-index. There is a similar issue for e-index. In that
case, to compute the e-index, we need the number of citations of your h most-cited articles.
Therefore, we only compute e-index if your h-index is at most 100.
## Support the Project
You can support the project in a number of ways:
* __Starring__: If you find this utility
useful, consider starring the GitHub repository.
* __Sharing with Others__: Consider sharing it with others who
you feel might find it useful.
* __Reporting Issues__: If you find a bug or have a suggestion for
a new feature, please report it via
the [Issue tracker](https://github.com/cicirello/bibliometrics/issues). Please
note, however, that feature requests will be evaluated for whether they
can be implemented while respecting Google Scholar's robots.txt, which means
limited to what can be computed from the first page of your Google Scholar
profile.
* __Contributing Code__: If there is an open issue that you think
you can help with, submit a pull request.
* __Sponsoring__: You can also consider sponsoring via one of the following:
| [](https://github.com/sponsors/cicirello) | [](https://liberapay.com/cicirello) |
| :---: | :---: |
| [](https://ko-fi.com/cicirello) | |
## Contribute
If you would like to contribute start by reading
the [contribution guidelines](https://github.com/cicirello/.github/blob/main/CONTRIBUTING.md).
This project has adopted
the [Contributor Covenant Code of Conduct](https://github.com/cicirello/.github/blob/main/CODE_OF_CONDUCT.md).
The intention of this utility is as a tool for a researcher to generate an SVG of their own
bibliometrics, so issues requesting, or pull requests implementing, support for multiple scholar
profiles will be rejected.
## License
The code in this repository is released under
the [MIT License](https://github.com/cicirello/bibliometrics/blob/main/LICENSE).
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.8 | Python |
نحوه نصب
نصب پکیج whl bibliometrics-2.3.0:
pip install bibliometrics-2.3.0.whl
نصب پکیج tar.gz bibliometrics-2.3.0:
pip install bibliometrics-2.3.0.tar.gz