artbase 0.0.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87bc502d50a03cc25b694c89244023a1941c037f7940a942a092faa69c73b43d
-  data.tar.gz: 5746f5444e7baf0d61399c3f294a5a34222077832100eccac96cad1df4f6683a
+  metadata.gz: 549b31d6f628fcb714c22fd03f179b75fd9b99e9c2bbe8532b1e79660e4f1ade
+  data.tar.gz: aadb6b67430375da20a83e94362562405dfca370dac2b8cfe514086a926ff2df
 SHA512:
-  metadata.gz: b38b6d8785e9302125fc447ff2eee16d4293cdc4960448b7579f56702f7ab8bda347a90fe13c1b70e0fbcc3b6bc3ccd89295f32758144a3fda361248578e8eee
-  data.tar.gz: dc14177cc1236ecadafc3d3330de68367b17f272aa77c50f045fd1eb1906367d1b920ae5948c276199a4df0c4a49688b2f34ea9f09f83cac1b04e5629790c960
+  metadata.gz: c7d1a745322df0250841c03975135d35f0f4ab4a9b8258e36482258e14b1847cece236b09755fd8962b6e942b21ed1ee5b28449c0d0b4d32f9f3c7c08e508533
+  data.tar.gz: 735c9079a101dd5aea55d5cb8458256082864e07bcaef81dff178cdeabb583df381ff9880d6aca7871c094a7f529342a9a206f4a4d877efe9c9b6b6b2600c27f

data/CHANGELOG.md

@@ -1,3 +1,3 @@
-### 0.0.1 / 2018-10-18
-
-* Everything is new. First release
+### 0.0.1 / 2018-10-18
+
+* Everything is new. First release

data/Manifest.txt

@@ -2,5 +2,17 @@ CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile
+bin/artbase
 lib/artbase.rb
+lib/artbase/attributes.rb
+lib/artbase/collection.rb
+lib/artbase/collection/base.rb
+lib/artbase/collection/image.rb
+lib/artbase/collection/opensea.rb
+lib/artbase/collection/token.rb
+lib/artbase/helper.rb
+lib/artbase/image.rb
+lib/artbase/image/sample.rb
+lib/artbase/retry.rb
+lib/artbase/tool.rb
 lib/artbase/version.rb

data/README.md

@@ -1,26 +1,272 @@
-#   Art Base
-
-artbase  gem
-
-* home  :: [github.com/pixelartexchange/opensea.sandbox](https://github.com/pixelartexchange/opensea.sandbox)
-* bugs  :: [github.com/pixelartexchange/opensea.sandbox/issues](https://github.com/pixelartexchange/opensea.sandbox/issues)
-* gem   :: [rubygems.org/gems/artbase](https://rubygems.org/gems/artbase)
-* rdoc  :: [rubydoc.info/gems/artbase](http://rubydoc.info/gems/artbase)
-* forum :: [wwwmake](http://groups.google.com/group/wwwmake)
-
-
-## Usage
-
-to be done
-
-
-## License
-
-The `artbase` scripts are dedicated to the public domain.
-Use it as you please with no restrictions whatsoever.
-
-
-## Questions? Comments?
-
-Send them along to the [wwwmake forum](http://groups.google.com/group/wwwmake).
-Thanks!
+# artbase ("right-clicker") command line tool & scripts - download complete pixel art collections - yes, you can! - automate "right-click 'n' save" and much more
+
+* home  :: [github.com/pixelartexchange/artbase](https://github.com/pixelartexchange/artbase)
+* bugs  :: [github.com/pixelartexchange/artbase/issues](https://github.com/pixelartexchange/artbase/issues)
+* gem   :: [rubygems.org/gems/artbase](https://rubygems.org/gems/artbase)
+* rdoc  :: [rubydoc.info/gems/artbase](http://rubydoc.info/gems/artbase)
+
+
+
+## Usage
+
+
+Note:  The artbase is alpha - it's still the early days - it's a work-in-progress.
+
+
+
+
+Let's try the 100 Blocky Doge (60x60) collection.
+
+
+### Step 0  - Collection Configuration Script
+
+Create a directory with the collection slug (e.g. `blockydoge`)
+matching the OpenSea collection slug
+and add a config script - `blockydoge/config.rb`:
+
+``` ruby
+COLLECTION = Collection.new( 
+
+'blockydoge',          # opensea collection slug
+100,                   # number of items
+
+format: '60x60',       # original pixel format
+source: '512x512',     # "big" source pixel format for 
+                       #   downloaded image referenced in meta data  
+
+#####
+#   "automagically" get the id from the meta data name field 
+#     via a "one-off / custom / hand-written" regex
+#   e.g. Blocky Doge #1  => 1
+meta_slugify: /^Blocky Doge #(?<num>[0-9]+)$/,
+)
+```
+
+Sorry for the "magic" config format for now  -
+see the [**artbase.sandbox**](https://github.com/pixelartexchange/artbase.sandbox) for many more "real-world" examples.
+
+
+
+
+
+That's it now you can:
+
+- Download all meta data files via the OpenSea API
+- Download all referenced images in the meta data file
+- Pixelate all downloaded images from the source format (e.g. 512x512) to the original format (e.g. 60x60)
+- Generate an all-in-one composite with the pixelated images
+- Export all meta data attributes / traits to an all-in-one datafile in the comma-separated-values (.csv) format
+
+
+### Download all meta data files via the OpenSea API
+
+Let's try:
+
+```
+$ artbase blockydoge meta
+```
+
+Note: All token meta data files get stored by convention in `blockydoge/token`.
+Resulting in a file tree like:
+
+```
+blockydoge/token/
+  0.json
+  1.json
+  2.json
+  3.json
+  4.json
+  5.json
+  6.json
+  7.json
+  8.json
+  9.json
+  10.json
+  11.json
+  12.json
+  ...
+```
+
+Example - `blockydoge/token/0.json`:
+
+``` json
+{
+  "id":                  52224520,
+  "token_id":            "154226446513437...7290852067901441",
+  "image_url":           "https://lh3.googleusercontent.com/fIQQ0A7...gTlbgMTQ",
+  "image_preview_url":   "https://lh3.googleusercontent.com/fIQQ0A7...gTlbgMTQ=s250",
+  "image_thumbnail_url": "https://lh3.googleusercontent.com/fIQQ0A7...gTlbgMTQ=s128",
+  "image_original_url":  null,
+  "name":                "Blocky Doge #1",
+  "description":         "Blocky Doge ... 100 unique pixelated Doge avatars...",
+
+  ...
+
+   "traits": [
+       { "trait_type": "Fur",        "value": "Red Fur",        ... },
+       { "trait_type": "Hat",        "value": "Pink Party Hat", ... },
+       { "trait_type": "Expression", "value": "Smiley",         ... },
+  ],
+
+  ...
+}
+```
+
+
+
+### Download all referenced images in the token meta data file
+
+Let's try:
+
+```
+$ artbase blockydoge img
+```
+
+Note: All referenced images (in the source format e.g. 512x512)
+get stored by convention in `blockydoge/token-i`.
+Resulting in a file tree like:
+
+```
+blockydoge/token-i/
+  0.png
+  1.png
+  2.png
+  3.png
+  4.png
+  5.png
+  6.png
+  7.png
+  8.png
+  9.png
+  10.png
+  11.png
+  12.png
+  ...
+```
+
+Example - `blockydoge/token-i/0.png` (512x512):
+
+![](i/blockydoge0-512x512.png)
+
+
+
+
+
+### Pixelate all downloaded images from the source format (e.g. 512x512) to the original format (e.g. 60x60)
+
+Let's try:
+
+```
+$ artbase blockydoge px
+```
+
+Note: All referenced images pixelated down to the orginal format (e.g. 60x60)
+get stored by convention in `blockydoge/60x60`.
+Resulting in a tree like:
+
+```
+blockydoge/60x60/
+  1.png
+  2.png
+  3.png
+  4.png
+  5.png
+  6.png
+  7.png
+  8.png
+  9.png
+  10.png
+  11.png
+  12.png
+  13.png
+  ...
+```
+
+
+Example - `blockydoge/60x60/1.png` to `13.png`:
+
+![](i/blockydoge000001.png)
+![](i/blockydoge000002.png)
+![](i/blockydoge000003.png)
+![](i/blockydoge000004.png)
+![](i/blockydoge000005.png)
+![](i/blockydoge000006.png)
+![](i/blockydoge000007.png)
+![](i/blockydoge000008.png)
+![](i/blockydoge000009.png)
+![](i/blockydoge000010.png)
+![](i/blockydoge000011.png)
+![](i/blockydoge000012.png)
+![](i/blockydoge000013.png)
+
+
+
+
+### Generate an all-in-one composite with the pixelated images
+
+Let's try:
+
+```
+$ artbase blockydoge composite
+```
+
+Note: The all-in-one composite image gets saved by convention to `blockydoge/tmp/blockydoge-60x60.png`.  Example:
+
+![](i/blockydoge-60x60.png)
+
+
+
+### Export all meta data attributes / traits to an all-in-one datafile in the comma-separated-values (.csv) format
+
+
+Let's try:
+
+```
+$ artbase blockydoge export
+```
+
+Note: The all-in-one datafile gets saved by convention to `blockydoge/tmp/blockydoge.csv`.
+Example:
+
+
+```
+ID, Name, Fur, Hat, Expression, Glasses, Accessories, Mask, Collar
+0, Blocky Doge #1, Red Fur, Pink Party Hat, Smiley, , , ,
+1, Blocky Doge #2, Black and Tan Fur, Orange Cap, Tongue Out, , , ,
+2, Blocky Doge #3, , , Cream Fur, Teal Glasses, , ,
+3, Blocky Doge #4, Meme Fur, , , Maroon Glasses, , ,
+4, Blocky Doge #5, Black and Tan Fur, Blue Party Hat, , , , ,
+5, Blocky Doge #6, Red Fur, Pink Cap, , , , ,
+6, Blocky Doge #7, Red Fur, , , , None, ,
+7, Blocky Doge #8, Meme Fur, White Cap, , , , ,
+8, Blocky Doge #9, Cream Fur, , , Sunglasses, , ,
+9, Blocky Doge #10, Meme Fur, , , , , Lavender Mask,
+10, Blocky Doge #11, Black and Tan Fur, , , Black Glasses, , ,
+11, Blocky Doge #12, Black and Tan Fur, , , , , Salmon Mask,
+12, Blocky Doge #13, Cream Fur, Green Party Hat, , , , ,
+...
+```
+
+
+
+
+That's it for now.
+
+
+
+## Install
+
+Just install the gem:
+
+    $ gem install artbase
+
+
+## License
+
+The `artbase` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+Post them on the [D.I.Y. Punk (Pixel) Art reddit](https://old.reddit.com/r/DIYPunkArt). Thanks.

data/Rakefile

@@ -1,29 +1,40 @@
-require 'hoe'
-require './lib/artbase/version.rb'
-
-Hoe.spec 'artbase' do
-
-  self.version = Artbase::VERSION
-
-  self.summary = "artbase"
-  self.description = summary
-
-  self.urls    = { home: 'https://github.com/pixelartexchange/opensea.sandbox'}
-
-  self.author  = 'Gerald Bauer'
-  self.email   = 'wwwmake@googlegroups.com'
-
-  # switch extension to .markdown for gihub formatting
-  self.readme_file  = 'README.md'
-  self.history_file = 'CHANGELOG.md'
-
-  self.extra_deps = [
-  ]
-
-  self.licenses = ['Public Domain']
-
-  self.spec_extras = {
-    required_ruby_version: '>= 2.2.2'
-  }
-
-end
+require 'hoe'
+require './lib/artbase/version.rb'
+
+
+###
+# hack/ quick fix for broken intuit_values - overwrite with dummy
+class Hoe
+  def intuit_values( input ); end
+end
+
+
+Hoe.spec 'artbase' do
+
+  self.version = Artbase::VERSION
+
+  self.summary = "artbase"
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/pixelartexchange/artbase'}
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+    ['cocos', '>= 0.1.2'],
+    ['webclient', '>= 0.2.2'],
+    ['pixelart', '>= 1.3.6'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.2.2'
+  }
+
+end

data/bin/artbase

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+###################
+# == DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -Ilib bin/artbase
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/artbase
+#
+
+require 'artbase'
+
+Artbase::Tool.main

data/lib/artbase/attributes.rb

@@ -0,0 +1,83 @@
+
+
+def counter_to_text( counter )
+
+  counter = counter.to_a
+
+  attribute_counter = counter[0]
+  more_counter      = counter[1..-1]
+
+
+  puts "Attribute Counts\n"
+  trait_type, h = attribute_counter
+
+  total = h[:by_type].values.reduce(0) { |sum,count| sum+count }
+
+
+  types = h[:by_type]
+  types = types.sort { |l,r| l[0]<=>r[0] }  ## sort by name
+
+  puts "\n"
+  puts "|Name|Total (%)|"
+  puts "|--------|----------:|"
+
+  types.each do |rec|
+      name     = rec[0]
+      count    = rec[1]
+      percent =  Float(count*100)/Float(total)
+
+      puts "| **#{name} Attributes** | #{count} (#{'%.2f' % percent}) |"
+  end
+  puts "\n"
+
+  more_counter.each_with_index do |(trait_type, h),i|
+    print " · "  if i > 0   ## add separator
+    print "#{trait_type } (#{h[:by_type].size})"
+  end
+  puts "\n\n"
+
+
+
+  more_counter.each do |trait_type, h|
+    print "### #{trait_type } (#{h[:by_type].size}) - "
+    print "∑Total #{h[:count]}/#{total}\n"
+
+    puts "\n"
+    puts "|Name|Total (%)|"
+    puts "|--------|----------:|"
+
+      types = h[:by_type]
+      types = types.sort do |l,r|
+                            # sort by 1) by count
+                            #         2) by name a-z
+                                  res = r[1] <=> l[1]
+                                  res = l[0] <=> r[0]  if res == 0
+                                  res
+                         end  ## sort by count
+      types.each do |rec|
+         name     = rec[0]
+         count    = rec[1]
+         percent =  Float(count*100)/Float(total)
+
+         puts "| **#{name}** | #{count} (#{'%.2f' % percent}) |"
+      end
+      puts "\n\n"
+    end
+end
+
+
+
+
+def counter_to_csv( counter )
+
+  puts "type, name, count"
+  counter.each do |trait_type, h|
+    puts "#{trait_type}, ∑ Total, #{h[:count]}"
+    h[:by_type].each do |trait_value, count|
+       puts "#{trait_type}, #{trait_value}, #{count}"
+    end
+  end
+end
+
+
+