Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add description and dependancy information.
  • Loading branch information
ishita-17 authored Oct 13, 2024
1 parent 0493d5f commit 9277a78
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Text mining scholarly API

The project helps download the full text of scholarly publications for a given list of DOIs using the Crossref API. It then stores the full text files in a MongoDB database.

The project runs using Python3 code and requires the following Python libraries:
1. habanero
2. pymongo
3. bson
4. requests
5. lxml
6. io

For more detailed descriptions for running, please refer to the `requirements.txt` file.


`dois.txt` : Text file that contains the 286 DOIs

`output.txt` : Text file that produces after running through the API pipeline
Expand Down

0 comments on commit 9277a78

Please sign in to comment.