AnimeDL 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae72467ac0c208f3d5cf9c906ef0851aa5696ef5
-  data.tar.gz: c951e243736a6c9b66e6d44d593f08ff91cd7433
+  metadata.gz: 3d0492b981a8fec13af761f4aad16fb1f56e4b2e
+  data.tar.gz: 4b4d0778dc4cbf907a3e38eaf0a552a79c21986b
 SHA512:
-  metadata.gz: d5be7d5f452d48a8daf84e79519c5c2b01653ea169f85cb31052b6c87b5544102bba9ed472a70935c41d7a1093b6e8a70208c9faf33ef68e58251ca32c95841e
-  data.tar.gz: 61569117a9d286942dac09f63211d3d76a67a7a6b6c8a2bf3f923a0599a7faa1d740165decbf5a2bc6a65f70f807a17fba4d8896c5f3f5f3c2e21907e078ef29
+  metadata.gz: df971dc3b3c6e81f716675a55a27e2f91248b75c4106f9c77d7f028e1684c7b20c6f437be3dab7307264640110e135323ad3b3901e88667f3d1554ee563a4652
+  data.tar.gz: 7d5976e3131a6f1b0ea9ec991f8df5d73e58f86fac65f5e8d2aa16b78c8175358cf5e9c3dd65951611cd929b1f3b5621691a765c6ac8d09ba230c3f6f147548b

data/README.md

@@ -1,10 +1,23 @@
 # AnimeDL
 
+<p align='center' style="width: 75%">
+<img src='fmab_anime_dl.jpg' alt='FMAB Stone'>
+</p>
+
+An app used to download anime episodes or get links to video sources of episodes without having to open your browser or go through annoying pop-up ads.
+
 ## Installation
 
-Add this line to your application's Gemfile:
 
-```
+Install the application with:
+
+    $ gem install AnimeDL
+
+
+<br>
+
+To use this in a projext, add this line to your application's Gemfile:
+```ruby
 gem 'AnimeDL'
 ```
 
@@ -12,13 +25,67 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install AnimeDL
 
 ## Usage
 
-TODO: Write usage instructions here
+On running the command the program prompts the user for a search query and prints a list of search results.  
+The user can then choose a particular anime.  Details for all episodes are scraped.  
+To select particular episodes call the app with the '-e' option.
+
+
+#### Links:
+ To output links to a file, provide the path to a file as the last argument.  
+ If argument is a directory, a new text file will be created in that directory.
+
+#### Downloads: 
+To download videos to particular directory, specify the directory as the last argument.  
+If no directory is specified the videos are downloaded to ./anime_name/
+
+### Examples:
+    `$ anime_dl`                                        - (outputs link urls on the terminal)    
+    `$ anime_dl -f rel/path/to/filename.txt`            - (outputs link urls to 'rel/path/to/filename.txt')  
+    `$ anime_dl -o link -f rel/path/to/directory/`      - (outputs link urls to 'rel/path/to/directory/anime\_name.txt')  
+    `$ anime_dl -o download`                            - (downloads videos to './anime\_name/')  
+    `$ anime_dl -o download -f .`                       - (downloads videos to './')  
+    `$ anime_dl -o d -f /abs/path/to/directory`         - (downloads videos to '/abs/path/to/directory/anime\_name/')  
+    `$ anime_dl -o download -f /abs/path/to/directory/` - (downloads videos to '/abs/path/to/directory/anime\_name/')   
+
+### Example App Usage:
+```
+$ anime_dl -q
+    Enter Search Query: fullmetal alchemist b
+
+    0. (Exit)
+    1. Fullmetal Alchemist Brotherhood Dubbed | Hagane no Renkinjutsushi (2009) Dubbed
+    2. Fullmetal Alchemist Brotherhood | Hagane no Renkinjutsushi (2009)
+    3. (Enter new Search Query)
+
+    Choice: 4
+
+    (Empty response gets all episodes, '-1' exits)
+
+    Total number of Episodes - 64  (1-64)
+    Episodes: -1
+```
+
+
+### Specifying Episodes: 
+When the '-e' option is not provided, the app asks for 'Episodes' after retrieving the user's anime choice.  
+The user can provide induvidual space-seperated episodes.
+The user can also provide multiple space-seperated ranges with each range having the format 'start-end'.  
+Below are a few examples (assuming anime has more than 18 episodes).  
+    `Episodes: 2 4 5` - Retrieves details for episodes 2, 4 and 5  
+    `Episodes: 4-8` - Retrieves details for episodes 4 to 8  
+    `Episodes: 8-l` - Retrieves details for episodes 8 to the last episode  
+    `Episodes: 2 9-13 18-l` - Retrieves details for episodes 2, 9 to 13 and 18 to end 
+
+### Other options
+Run `$ anime_dl -h` for the list of all options. 
+
+## Limitations
+The page being scraped from, "animeheaven.eu", only allows a certain number of page views per day (>150, <300).
+Once that limit is exceeded, you will have to change networks or try again in 24 hours.
+
 
 
 ## License

data/anime_dl.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "AnimeDL"
-  spec.version       = "0.1.2"
+  spec.version       = "0.1.4"
   spec.authors       = ["Anirudh Sundar"]
   spec.email         = "anirudhsundar@hotmail.com"
 

data/bin/anime_dl

@@ -40,7 +40,7 @@ ARGV.options do |opts|
     options[:option] = option
   end
 
-  opts.on("-e", "--episode", help_statements[:episode]) do
+  opts.on("-a", "--all", help_statements[:episode]) do
     options[:episode] = false
   end
 
@@ -60,13 +60,13 @@ ARGV.options do |opts|
 
   opts.separator ""
   opts.separator "Examples:"
-  opts.separator %Q[  `anime_dl`                                        (outputs link urls on the terminal)]
-  opts.separator %Q[  `anime_dl -f rel/path/to/filename.txt`            (outputs link urls to 'rel/path/to/filename.txt')]
-  opts.separator %Q[  `anime_dl -o link -f rel/path/to/directory/`      (outputs link urls to 'rel/path/to/directory/anime_name.txt')]
-  opts.separator %Q[  `anime_dl -o download`                            (downloads videos to './anime_name/')]
-  opts.separator %Q[  `anime_dl -o download -f .`                       (downloads videos to './')]
-  opts.separator %Q[  `anime_dl -o d -f /abs/path/to/directory`         (downloads videos to '/abs/path/to/directory/anime_name/')]
-  opts.separator %Q[  `anime_dl -o download -f /abs/path/to/directory/` (downloads videos to '/abs/path/to/directory/anime_name/')]
+  opts.separator %Q[  `$ anime_dl`                                        (outputs link urls on the terminal)]
+  opts.separator %Q[  `$ anime_dl -f rel/path/to/filename.txt`            (outputs link urls to 'rel/path/to/filename.txt')]
+  opts.separator %Q[  `$ anime_dl -o link -f rel/path/to/directory/`      (outputs link urls to 'rel/path/to/directory/anime_name.txt')]
+  opts.separator %Q[  `$ anime_dl -o download`                            (downloads videos to './anime_name/')]
+  opts.separator %Q[  `$ anime_dl -o download -f .`                       (downloads videos to './')]
+  opts.separator %Q[  `$ anime_dl -o d -f /abs/path/to/directory`         (downloads videos to '/abs/path/to/directory/anime_name/')]
+  opts.separator %Q[  `$ anime_dl -o download -f /abs/path/to/directory/` (downloads videos to '/abs/path/to/directory/anime_name/')]
   opts.separator ""
 
   opts.separator "Example App Usage:"
@@ -95,7 +95,7 @@ ARGV.options do |opts|
   opts.separator ""
   opts.separator "NOTE: "
   opts.separator "The page being scraped from, \"animeheaven.eu\", only allows a certain number of page views per day (>150, <300)."
-  opts.separator "Once that limit is exceed, you will have to change networks or try again in 24 hours."
+  opts.separator "Once that limit is exceeded, you will have to change networks or try again in 24 hours."
 
   begin
     opts.parse!
@@ -149,7 +149,7 @@ unless (options[:quiet])
               "    `Episodes: 4-8` - Retrieves details for episodes 4 to 8\n" +
               "    `Episodes: 8-l` - Retrieves details for episodes 8 to the last episode\n" +
               "    `Episodes: 2 9-13 18-l` - Retrieves details for episodes 2, 9 to 13 and 18 to end\n" +
-              "(Enter empty response to get all episodes, '-1' exits).\n\n"
+              "(Enter empty response to get all episodes, '-1' exits)\n\n"
   }
 else
   $user_prompts = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: AnimeDL
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Anirudh Sundar
@@ -36,6 +36,7 @@ files:
 - README.md
 - anime_dl.gemspec
 - bin/anime_dl
+- fmab_anime_dl.jpg
 - lib/anime_dl.rb
 - lib/anime_dl/anime_heaven.rb
 - lib/episode.rb