Metadata-Version: 2.1
Name: kirsche
Version: 0.2.4
Summary: Kirsche, connecting your papers.
Home-page: https://github.com/kausalflow/kirsche
Author: L Ma
Author-email: hi@leima.is
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: click (>=7.0.0)
Requires-Dist: requests (>=2.26.0)
Requires-Dist: loguru (>=0.5.3)
Requires-Dist: bibtexparser (>=1.2.0)
Requires-Dist: matplotlib (==3.4.3)
Requires-Dist: pyecharts (==1.5.0)
Requires-Dist: pandas (>=1.0.0)
Requires-Dist: openpyxl (>=3.0.7)
Requires-Dist: nose (>=1.3.7)
Provides-Extra: all
Requires-Dist: mkdocstrings (>=0.15.0) ; extra == 'all'
Requires-Dist: mkdocs-autorefs (>=0.1.1) ; extra == 'all'
Requires-Dist: mkdocs-material (>=0.4.4) ; extra == 'all'
Requires-Dist: nose ; extra == 'all'
Provides-Extra: docs
Requires-Dist: mkdocstrings (>=0.15.0) ; extra == 'docs'
Requires-Dist: mkdocs-autorefs (>=0.1.1) ; extra == 'docs'
Requires-Dist: mkdocs-material (>=0.4.4) ; extra == 'docs'
Provides-Extra: mkdocs-autorefs
Requires-Dist: mkdocs-autorefs (>=0.1.1) ; extra == 'mkdocs-autorefs'
Provides-Extra: mkdocs-material
Requires-Dist: mkdocs-material (>=0.4.4) ; extra == 'mkdocs-material'
Provides-Extra: mkdocstrings
Requires-Dist: mkdocstrings (>=0.15.0) ; extra == 'mkdocstrings'
Provides-Extra: nose
Requires-Dist: nose ; extra == 'nose'
Provides-Extra: tests
Requires-Dist: nose ; extra == 'tests'

# kirsche


Kirsche is a python package to build up connections between papers.

## How to Use

- Install the package: `pip install kirsche`
- In your command line, run `kirsche --help` to see possible commands.


## Caveats

### About SemanticScholar API

We are using [SemanticScholar API](https://www.semanticscholar.org/product/api) to get the paper metadata. The API has some rate limits ([100 requests per 5 minutes](https://www.semanticscholar.org/product/api)).

A possible workaround for large number of papers is to split them into batches.

Todo:
- [ ] Use API keys from SemanticScholar.

