-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
30 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,33 @@ | ||
# Cuterle | ||
Bioinformatic tool which extract every domain annotated by InterProScan | ||
|
||
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ | ||
| __ _____ _____ ____ _____ / \\ | ||
| / \ | | | | | \ | | / \\ | ||
| | | | | |__ |___/ | |__ / _ _ _ _ \\ | ||
| | | | | | |\ | | \ \\ | ||
| \__/ \__/ | |____ | \ |___ |____ \ \\ | ||
|_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _\ _ _ _ _ _\\ | ||
![](./screenshots/main_home.png) | ||
|
||
## Getting started | ||
|
||
### Prerequisites | ||
|
||
- Python | ||
- pip | ||
|
||
### Installation | ||
|
||
Install the required Python packages; while you are in the project's root directory run the following command: | ||
|
||
```bash | ||
# Install requirements | ||
pip install -r requirements.txt | ||
``` | ||
|
||
### Usage | ||
|
||
In terminal, run the following command. By default, this will only retrieve Bulbasaur. | ||
|
||
```bash | ||
# Run the Serebii.net scraper | ||
python scraper.py | ||
``` | ||
|
||
Some useful commands are listed below. | ||
|
||
```bash |