Skip to content

Commit 86b402d

Browse files
committed
modified function name from download to downloader, Rectified README.md
1 parent 4ed26d1 commit 86b402d

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
- [Disclaimer](#disclaimer)
66
- [Installation](#installation)
77
- [Usage](#usage)
8-
- [Requirements](#requirements)
98
- [License](#license)
109
- [Contact](#contact)
1110

@@ -39,8 +38,10 @@ pip install better-bing-image-downloader
3938
### Usage <br />
4039

4140
```python
42-
from better_bing_image_downloader import download
43-
download.download(query_string, limit=100, output_dir='dataset', adult_filter_off=True, force_replace=False, timeout=60, verbose=True)
41+
from better_bing_image_downloader import downloader
42+
43+
downloader(query_string, limit=100, output_dir='dataset', adult_filter_off=True,
44+
force_replace=False, timeout=60, filter="", verbose=True, badsites= [], name='Image')
4445
```
4546

4647
`query_string` : String to be searched.<br />
@@ -52,6 +53,7 @@ download.download(query_string, limit=100, output_dir='dataset', adult_filter_o
5253
`filter` : (optional, default is "") filter, choose from [line, photo, clipart, gif, transparent]<br />
5354
`verbose` : (optional, default is True) Enable downloaded message.<br />
5455
`bad-sites` : (optional, defualt is empty list) Can limit the query to not access the bad sites.<br/>
56+
`name` : (optional, default is 'Image') Can add a custom name for the images that are downloaded.<br/>
5557

5658
### License
5759

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
from .bing import Bing
2-
from .download import download
2+
from .download import downloader

better_bing_image_downloader/download.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
except ImportError: # Python 3
1111
from .bing import Bing
1212

13-
def download(query, limit=100, output_dir='dataset', adult_filter_off=True,
13+
def downloader(query, limit=100, output_dir='dataset', adult_filter_off=True,
1414
force_replace=False, timeout=60, filter="", verbose=True, badsites= [], name='Image'):
1515
"""
1616
Download images using the Bing image scraper.
@@ -66,5 +66,5 @@ def download(query, limit=100, output_dir='dataset', adult_filter_off=True,
6666
parser.add_argument('-n', '--name', type=str, default='Image', help='The name of the images.')
6767
args = parser.parse_args()
6868

69-
download(args.query, args.limit, args.output_dir, args.adult_filter_off,
69+
downloader(args.query, args.limit, args.output_dir, args.adult_filter_off,
7070
args.force_replace, args.timeout, args.filter, args.verbose, args.bad_sites, args.name)

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setuptools.setup(
77
name="better_bing_image_downloader",
8-
version="1.0.3",
8+
version="1.0.4",
99
author="Krishnatejaswi S",
1010
author_email="shentharkrishnatejaswi@gmail.com",
1111
description="This package is built on top of bing-image-downloader by gaurav singh",

0 commit comments

Comments
 (0)