Metadata-Version: 2.1
Name: kirsche
Version: 0.2.8
Summary: Kirsche, connecting your papers.
Home-page: https://github.com/kausalflow/kirsche
Author: L Ma
Author-email: hi@leima.is
License: MIT
Description-Content-Type: text/markdown
Provides-Extra: docs
Provides-Extra: mkdocs-autorefs
Provides-Extra: mkdocs-click
Provides-Extra: mkdocs-material
Provides-Extra: mkdocstrings[python]
Provides-Extra: tests
Provides-Extra: pytest
Provides-Extra: pytest-cov
Provides-Extra: all
License-File: LICENSE

# 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.
