https://github.com/j-e-j-s/protocol-scraper
A Python CLI that Automates Scientific Protocol Writing.
https://github.com/j-e-j-s/protocol-scraper
cli data-mining python-cli science science-for-all science-research
Last synced: 4 months ago
JSON representation
A Python CLI that Automates Scientific Protocol Writing.
- Host: GitHub
- URL: https://github.com/j-e-j-s/protocol-scraper
- Owner: J-E-J-S
- License: other
- Created: 2020-05-21T07:40:00.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-22T21:40:47.000Z (about 2 years ago)
- Last Synced: 2025-02-01T03:46:16.528Z (5 months ago)
- Topics: cli, data-mining, python-cli, science, science-for-all, science-research
- Language: Python
- Homepage:
- Size: 176 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Protocol Scraper ⚗️
### A Python CLI that Automates Scientific Protocol Writing.
### Introduction
This CLI scrapes protocols from [Protocols.io API](https://apidoc.protocols.io/) to automate protocol collection and writing.
Specify the number of protocols you want to scrape and analyze the generated .txt files to select the best protocol for your needs.
For obscure protocols it may be required to generate multiple protocols and collate to form the instructions for your needs.
### Prerequisites:
* Python >=3.6
### Quick Start:
```
pip install protocol-scraper
```
### Usage:
```
Usage: protocol-scraper [OPTIONS] PROTOCOL
Arguments:
PROTOCOL The protocol to write.
Options:
-l, --limit INTEGER Number of test protocols to write. Default = 3
--help Show this message and exit.
```
e.g.
```
protocol-scraper 'Gel Electrophoresis' -l 10
```
### Output:
The CLI will output .txt files containing the scraped protocols to the limit specified.
See Examples directory for more insight.