mehedih / bulksplash Goto Github PK

View Code? Open in Web Editor NEW

523.0 14.0 55.0 1.28 MB

A simple command line tool that lets you bulk download images from Unsplash

Home Page: https://www.npmjs.com/package/bulksplash

License: GNU General Public License v3.0

JavaScript 100.00%

unsplash stock-images images command-line-tool command-line

bulksplash's Introduction

Bulksplash

A simple command line tool that lets you bulk download images from Unsplash, previously known as Unsplash Bulk Downloader.

Quick Start

To use Bulksplash, you need to install Node.js. Once you have Node.js installed, you can simple use the npx command to run Bulksplash:

npx bulksplash

This will automatically download and let you use Bulksplash. To be able to use Bulksplash wherever you like, you can install it globally using npm:

npm install bulksplash --g

Once installed, you can simply run bulksplash from the terminal on any folder to download images from Unsplash.

Obtaining an API key

To use Bulksplash, you NEED to obtain an API key for Unsplash. This can be done by signing up here and creating a Demo app. This will allow you to download 50 images per hour, but if you want to download more than that, you will need to apply for Production access via Unsplash Developers.

Options

Prompts in the terminal will guide you through the options for downloading images, with some default values for quicker use. The prompts are as follows:

What is your API key? - You need an API key for Unsplash to be able to use Bulksplash. Get one here.
Which directory do you want to save to? - The folder you want to download the pictures to. Defaults to your current directory
Which images do you want to download? - Whether you want to download images randomly or from a specific collection. Defaults to random
What search term? - A search term, or blank for random images. Defaults to blank
Enter the URL of the Unsplash collection you want to download from - The link of the Unsplash Collection you want to download Defaults to blank, needs to be a valid link
How many images (up to 50)? - The number of images to retrieve. Defaults to 20
Only featured images? - Should it only get featured images, curated by Unsplash? Defaults to Yes
What orientation? - What orientation should the images be? The options are Mixed, Portrait, Landscape, Squarish, or Custom. Mixed will get images regardless of orientation, while Custom allows you to choose a specific width and height. Defaults to Mixed
Width? - For any orientation, choose the width of the returned images. This is required when the Custom orientation is selected. Defaults to blank for original size
Height? - For Custom orientation, specify a height. This option is not displayed if the orientation is not
Export the credits for the photos to a .json file? - Whether to generate the bulksplash-credits.json file with all the details about hte photographers. Defaults to yes

Quick Usage

Bulksplash lets you directly use the tool without going through the prompt interface.

For example: bulksplash --a=50 --d=basket -c=https://unsplash.com/collections/9454911 --f --j --k=API_KEY will download 50 featured images from the "Basketball" collection into the "test" sub-folder and generate a credits file.

Available options:

--d: the directory you want to save images to.
--c: if you want to download images from a collection, enter the link of the Unsplash collection you want to download images from.
--q: if you want to download images about something specific, you can enter a search query.
--a: the number of images you want to download.
--w: the width of the images.
--h: the height of the images.
--o: the orientation of the images ("landscape", "portrait", "squarish")
--f: whether you want to download featured images.
--n: the name scheme of the downloaded images (0 for authorname-randomstring, 1 for numbered list)
--j: whether you want to generate a credits file.
--k: your Unsplash API key.

Please feel free to contribute to this tiny project and make it better and follow me on Twitter for more projects like this!

bulksplash's People

Contributors

Stargazers

Watchers

Forkers

1thinkdifferent sathishvj ernestpascual concealcanvas packingbox kyoungrok0517 sreerag-nair jaweesner nguyend08 danjohnsonnj isrugeek heysaturday nair-sreerag hoaitrang31 drpablito justinrobertohara outta pratikrjoshi lakshit1 siedner mehulagg nthpixel thisisyusuf arielsoriano menilv greasepigm mucstudio luqmanhy alexanderscott moidea jonathantroyer tengfoung ppang0405 bhtri microdog cufix raphzam c00renut kiptechie engel-droid zarei-dev matthewmayer smycek 00mjk squatto valabji goo0oogle thanasistrisp alanabrahampkochumon-zqict wooodhead prabapro anvilzero

bulksplash's Issues

Something went wrong, got response code 403 from Unsplash - Forbidden

Error pulling images. "got response code 403 from Unsplash - Forbidden"

Hi, I downloaded node.js, installed bulksplash as instructed (npm install), but I get the following result (example input):

C:\Users\***>bulksplash
? 📂 Which directory do you want to save to? F:/
? 📸 Which images do you want to download? Random
? 🔍 What search term? nature
? 👀 How many images? 100
? ⭐️ Only featured images? Yes
? 🤔 What orientation? Landscape
? 🖼 Width? (Optional, blank for original size)
? 🖼 Height? (Optional, blank for original size)
? 🗂  Export the credits for the photos to a .json file?  No

🤖 Welcome to Bulksplash! (Powered by Unsplash.com)

🔰 Downloading 100 featured "nature" images from:
🚨 Something went wrong, got response code 403 from Unsplash - Forbidden
🚨 Something went wrong, got response code 403 from Unsplash - Forbidden
🚨 Something went wrong, got response code 403 from Unsplash - Forbidden
🚨 Something went wrong, got response code 403 from Unsplash - Forbidden

C:\Users\****>

i can't run can you help me ?

go wrong for quick usage with prompt massege "got response code 401 from Unsplash - Unauthorized"

I try to use Bulksplash by the quick usage, but went wrong. and i use the Unsplash API Key go well through the prompt interface.

==quick usage===
F:\TEMP\tmp1>bulksplash --a=50 --d=basket --c=https://unsplash.com/collections/9454911 --f --j --k=0z_vd1QxOCCqOWJHA25NXHwETXIJ%
🤖 Welcome to Bulksplash! (Powered by Unsplash.com)
🔰 Downloading 20 images from:
🚨 Something went wrong, got response code 401 from Unsplash - Unauthorized

system: windows 10 professional 64bit

This downloads only unsplash.it images and not unsplash.com

Unsplash.it has "only" 1084 files
Unsplash.com has more than 184.000 photos

You can register to the official unsplash API however there is a limit

Add support for -h and --help

They should emit the documentation of the options.
Great work, btw!

Cannot find module progress

I ran your script and it returned like this:

node index --amount=10 --orientation=landscape --search=line 1 ↵

Welcome to Bulksplash! (Powered by Unsplash.com)

Downloading 10 random images :)
module.js:549
throw err;
^

Error: Cannot find module 'progress'
at Function.Module._resolveFilename (module.js:547:15)
at Function.Module._load (module.js:474:25)
at Module.require (module.js:596:17)
at require (internal/module.js:11:18)
at Object. (/Users/yoonnie/Bulksplash/index.js:34:19)
at Module._compile (module.js:652:30)
at Object.Module._extensions..js (module.js:663:10)
at Module.load (module.js:565:32)
at tryModuleLoad (module.js:505:12)
at Function.Module._load (module.js:497:3)

Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE

Self explanatory command output

➜ npx bulksplash 
Need to install the following packages:
  bulksplash
Ok to proceed? (y) y
npm WARN deprecated [email protected]: this library is no longer supported
npm WARN deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
npm WARN deprecated [email protected]: request has been deprecated, see https://github.com/request/request/issues/3142
? 📂 Which directory do you want to save to? .
? 📸 Which images do you want to download? Random
? 🔍 What search term? 
? 👀 How many images? 20
? ⭐️ Only featured images? Yes
? 🤔 What orientation? Squarish
? 🖼 Width? (Optional, blank for original size) 360
? 🗂  Export the credits for the photos to a .json file? No

🤖 Welcome to Bulksplash! (Powered by Unsplash.com)

🔰 Downloading 20 featured images from:
📸 Zoltan Tasi (https://unsplash.com/@zoltantasi)
📸 masahiro miyagi (https://unsplash.com/@masamasa3)
📸 Luis Gherasim (https://unsplash.com/@luisgherasim_d)
📸 Kate Darmody (https://unsplash.com/@kdarmody)
📸 Dongsh (https://unsplash.com/@dongsh)
📸 SIMON LEE (https://unsplash.com/@simonppt)
📸 Annie Spratt (https://unsplash.com/@anniespratt)
📸 Vlad Zaytsev (https://unsplash.com/@vladizlo)
📸 Maddie Leopardo (https://unsplash.com/@maddieleopardo)
📸 Amy Shamblen (https://unsplash.com/@amyshamblen)
📸 James Everitt (https://unsplash.com/@jameseverittphotography)
📸 Yehleen gaffney (https://unsplash.com/@yanagirl2020)
📸 Devon Hawkins (https://unsplash.com/@thelifeofdev)
📸 Andre Tan (https://unsplash.com/@andredantan19)
📸 Roman Melnychuk (https://unsplash.com/@chamooomile0)

⏳ Preparing download...

🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE
🚨 Error while downloading undefined UNABLE_TO_VERIFY_LEAF_SIGNATURE

Node: v14.15.4
NPM: 7.20.0

Rate Limit Exceeded. Please try again later.

I am getting the error while downlaoding the images

Pass API key without the prompt?

Hi,

the documentation is not saying which option should I use to pass my API key when I’m not using the prompt, can you add this information?

thanks

ECONNRESET error when trying to download images

I have an error that I can't resolve. I write:

node index --amount 5

And I get the following output:

Welcome to Bulksplash! (Powered by Unsplash.com)

Downloading 5 random images :)

Downloading images from:

Gordon Williams (http://unsplash.com/@artifactflash)
Elijah Henderson (http://unsplash.com/@elijahhenderson)
Cristy Zinn (http://unsplash.com/@c_zinn)
Markus Dorfer (http://unsplash.com/@markusdorfer)
Cindy Chen (http://unsplash.com/@cindychenc)
=====
events.js:160
      throw er; // Unhandled 'error' event
      ^

Error: read ECONNRESET
    at exports._errnoException (util.js:949:11)
    at TLSWrap.onread (net.js:563:26)

Any ideas how to fix it?
Thanks!

Response code 401 from Unsplash - Unauthorized @3.0.0

Having this issue previously mentioned, Something went wrong, got response code 401 from Unsplash - Unauthorized, request looks like this: `npx bulksplash --k=FPznGHr7fvyeOshfqfdXAN8r8GQBGCnLBbPFxqsXXXX --j --c=https://unsplash.com/collections/4494328/ocean-waves --a=10 --w=1920 --h=1080 --o=landscape'

Any ideas? Thanks!

Not downloading via Collection URl

Hello,

When I am adding a collection URL lets say for a niche of Luxury.

https://unsplash.com/s/collections/luxury

It's says the URL is invalid.

Do kindly let know if there is another format to enter a URL for collection.

Thanks

Determine if photo exists in filesystem before downloading?

Would you be willing to accept a PR which determines if a photo exists in the directory before attempting to download it again? This would help those on limited connections as well as reduce API calls as it appears you're having to pass one of the API tokens through to download.

My use case is that I have a public collection named Backgrounds which I add photos to whenever I see a background that I like. I then use Bulksplash to "sync" new photos (but currently it re-downloads them all) to my laptop's wallpaper directory.

How do I install / use this?

I am a newbie, how do I install or use this?

Download from user

Hi, as a photographer committing to Unsplash I use Bulksplash to redownload my images from Unsplash for a batch search on google images. Therefore it would be nice to have the possibility to download from a user URL instead a collection. At the moment I need to add manually every picture to a collection to make it work. The feature would save me some time. Thanks in advance for considering it and maybe implement it.

İts not working

Something went wrong, got response code 403 from Unsplash - Forbidden

Only 30 pictures download

after command node index --amount=1000
only 30 pictures download

node index --amount=1000

Welcome to Bulksplash! (Powered by Unsplash.com)

Downloading 1000 random images :)

Downloading images from:

Brxxto (https://unsplash.com/@brxxto)
Paul Jarvis (https://unsplash.com/@pjrvs)
Matt Aunger (https://unsplash.com/@mattaunger)
Julian Klumpers (https://unsplash.com/@julianklumpers)
reza shayestehpour (https://unsplash.com/@r_shayesrehpour)
Neven Krcmarek (https://unsplash.com/@nevenkrcmarek)
Vladimir Kudinov (https://unsplash.com/@madbyte)
Chris Benson (https://unsplash.com/@maui354)
Richard Clark (https://unsplash.com/@digimist)
Kaitlyn Jameson (https://unsplash.com/@willsk)
Zoltan Kovacs (https://unsplash.com/@kovacsz1)
Theodora Lee (https://unsplash.com/@theodoraaaa)
kazuend (https://unsplash.com/@kazuend)
Gabriel Santiago (https://unsplash.com/@gabrielssantiago)
Ahmet Yalçınkaya (https://unsplash.com/@ahmetyalcinkaya)
Todd Quackenbush (https://unsplash.com/@toddquackenbush)
Christoffer Engström (https://unsplash.com/@christoffere)
wu yi (https://unsplash.com/@takeshi2)
Jonathan M. Hethey (https://unsplash.com/@jonathanmh)
Tanaphong Toochinda (https://unsplash.com/@daen_2chinda)
Chris Benson (https://unsplash.com/@maui354)
Christian Löhner (https://unsplash.com/@diren89)
Daryn Bartlett (https://unsplash.com/@darynmae)
anne-marie robert (https://unsplash.com/@annemarierobert)
Kevin Rajaram (https://unsplash.com/@kevinrajaram)
Jack Gisel (https://unsplash.com/@jackgisel)
Ashim D’Silva (https://unsplash.com/@randomlies)
ludwig friborg (https://unsplash.com/@ludwig_friborg)
Jez Timms (https://unsplash.com/@jeztimms)
Allef Vinicius (https://unsplash.com/@seteales)
====---------------------------------------------------------------------------------------------------------------------------------------------

then exit with out error

service is disable some time, need to process request code != 200

Any way to save the image tags to an output file?

Hello! Is there a way to save the image tags to an output file? For instance, I might search for "man", but bulksplash (clever name by the way) would likely download many images with many different tags, like "man fishing lake" or "man bicycle". Is there any way to use bulksplash to save these tags to an output file as well?

Where can I add my personal API key?

Thank you for this great script!
Bulksplash didn't ask me about my API key. Is there an option where I can submit my own API key? It would be great if there was a separate option for that (e.g. "--key" or something like that).
Thank you

Missing ./images folder

Not sure why it wasn't being created, but I needed to manually run mkdir ./images or else I got a node error about the folder not being there.

npm package not updated with new changes

made my last contribution in hopes that it'd be easier to package bulksplash into other projects / install it locally with the new feature, but the npm package hasn't been re-published in two years. i know i could package the change myself locally, but in the interest of the new features being easily available to new downloaders, it might be good to re-publish the package - if it's not too much bother.

Is your client ID supposed to be in the code?

Bulksplash/index.js

Line 61 in 3a34a6d

    
           const clientId = '&client_id=1ced621f3ac7bb7836fc9b6bfbcff5656dd43eb2b60f4636e5ef53142ea19f2d'

How am I supposed to use this...?

Hi there. I see no executables. Is this only for Linux? If it is, boooooooooooooooooooooooooooooooooo

Windows and Mac users can't have nice things.

npm install error, security audit?

npm install
npm WARN The package nodeJs-zip is included as both a dev and production dependency.

up to date in 2.177s
[!] 3 vulnerabilities found [145 packages audited]
Severity: 2 Low | 1 High
Run npm audit for more detail

npm audit

                   === npm audit security report ===

┌──────────────────────────────────────────────────────────────────────────────┐
│ Manual Review │
│ Some vulnerabilities require your attention to resolve │
│ │
│ Visit https://go.npm.me/audit-guide for additional guidance │
└──────────────────────────────────────────────────────────────────────────────┘
┌───────────────┬──────────────────────────────────────────────────────────────┐
│ High │ Regular Expression Denial of Service │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Package │ minimatch │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Patched in │ >=3.0.2 │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Dependency of │ zip-folder [dev] │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Path │ zip-folder > archiver > glob > minimatch │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ More info │ https://nodesecurity.io/advisories/118 │
└───────────────┴──────────────────────────────────────────────────────────────┘
┌───────────────┬──────────────────────────────────────────────────────────────┐
│ Low │ Prototype Pollution │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Package │ lodash │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Patched in │ >=4.17.5 │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Dependency of │ zip-folder [dev] │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Path │ zip-folder > archiver > lodash │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ More info │ https://nodesecurity.io/advisories/577 │
└───────────────┴──────────────────────────────────────────────────────────────┘
┌───────────────┬──────────────────────────────────────────────────────────────┐
│ Low │ Prototype Pollution │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Package │ lodash │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Patched in │ >=4.17.5 │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Dependency of │ zip-folder [dev] │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Path │ zip-folder > archiver > zip-stream > lodash │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ More info │ https://nodesecurity.io/advisories/577 │
└───────────────┴──────────────────────────────────────────────────────────────┘

[!] 3 vulnerabilities found - Packages audited: 145 (59 dev, 6 optional)
Severity: 2 Low | 1 High