Giter VIP home page Giter VIP logo

biorxiv-api's Introduction

biorxiv-api

A command-line interface for retrieving preprint information from bioRxiv.

© Jan Samson (reach out at [email protected])

Usage

The field argument is the only required parameter. This pertains to the research area of interest. Optional flags are listed below.

Argument Alias Description
--out -o filepath to save output
--pages -p number of HTML pages to retrieve from server
--truncate -t subsets a table with a start and end indices
--filter -f filter the table by column headers

Listed below are optional boolean flags:

Argument Description
--no-header excludes the column names when writing stdout to file
--csv writes output to file as csv
--tsv writes ouput to file as tsv
--json writes output to file as json
--verbose print out program messages

Retrieve the most recent pre-prints in the field of bioinformatics.

# returns 10 articles by default
biorx.py bioinformatics

Retrieve article information from the first 3 pages of bioRxiv.

biorx.py bioinformatics --pages 3

Display the first five articles.

biorx.py bioinformatics --truncate 5

Extract all articles between the 8th and 15th articles.

biorx.py bioinformatics --pages 2 --truncate 8:15

Return the first 8 articles and sort by title.

biorx.py bioinformatics --truncate 8 --sort title

Display article information as json.

biorx.py bioinformatics --json

Todo

  • create tree object for navigating the HTML/XML document
  • generate dataclasses for storing article information
    • Author
    • Article
  • command line parser for providing program arguments
  • design command line interface with custom flags
  • convert API to client that supports HTTP connection pooling
  • support for stdin, stdout for piping operations
  • display output as json
  • download full article text to a specified file

User Stories

I should be able retrieve the most recent biorxiv pre-prints for a given field.

For each article, I should be able to view its TITLE, AUTHORS, DATE OF PUBLICATION, DOI, and ABSTRACT

biorxiv-api's People

Contributors

dagsdags212 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.