okshot 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2af2f80a814e29de154373240a87cef59d86f88a4cda9b65a88667fcdddacdc4
-  data.tar.gz: 52223a5ae5f903576588362c8df33afe70c75f329bb86f3a5666a463cba502a3
+  metadata.gz: 662c261d79f519a7aea72744143f0ed3a05b0f4a5051deb205e06209689f031b
+  data.tar.gz: 416b7c053d9528b91ba94d0f74b65fd5230b79dcf2136b198fa9281c6f0d3018
 SHA512:
-  metadata.gz: 28bf8f356ec6b90f530dac67166e31323488f211ed2987c61b182f94335ab8c643b791f0800ab8a79a242a420614d018b9e91f15fd7b6053c95fbac0dd93b3c8
-  data.tar.gz: bcfe1f0b9ba9235d553c77d24023c8a9ae14023ad2af7c99293b102feb7092aebce645e8b46c938eacfbd30794667d48c6e60817739e94751b590f1ea6151d73
+  metadata.gz: 20bd1a5dd9b717c4f1e32bda9932e49696e6bf7dc27a67e194eed9b3d9b37827a8d63d917e73d2fe1fc17884289f3a71ef01187731a00b2c5113ea8802ab7782
+  data.tar.gz: 20325ee6c378d621c19cebf139484e109f8d8c5c31f81f424f829bdf4ab8110b9bba5ca30c9504b2fcd6e40243a34413f86cbd3ea394301c67820ee7b59fba07

data/README.org

@@ -6,7 +6,7 @@
  \___/|_|\_\___/_| |_|\___/ \__|
 #+end_example
 
-#+html: <img src="https://github.com/200ok-ch/okshot/workflows/CI/badge.svg"/>
+# #+html: <img src="https://github.com/200ok-ch/okshot/workflows/CI/badge.svg"/>
 #+html: <a href="https://rubygems.org/gems/okshot"> <img src="https://badge.fury.io/rb/okshot.svg"/></a>
 
 * NAME
@@ -17,6 +17,7 @@
 
   #+begin_example
     Usage: okshot [options]
+        -s, --simple                     Take a screenshot without annotation and upload
         -c, --copy-clipboard             Copy PNG file from clipboard and upload
         -i, --inkscape                   Use inkscape to edit the screenshot and upload
   #+end_example
@@ -32,8 +33,13 @@ However, it's so very easy to build =okshot=, because
 
 For uploading the files via FTP, it needs these environment variables set:
 
+- OKSHOT_HOST
+- OKSHOT_USER
+- OKSHOT_PASSWORD
+- OKSHOT_URL_PREFIX
+
 For example, you can do this in your shell config file (=~/.bashrc=,
-=~/.zshrc=) or even via [[https://200ok.ch/posts/contextual-helpers-with-zsh-hooks.html][sourceme]]. For example:
+=~/.zshrc=) or via [[https://200ok.ch/posts/contextual-helpers-with-zsh-hooks.html][sourceme]]. For example:
 
 #+begin_example
 export OKSHOT_HOST=ftp.some-server.ch
@@ -42,87 +48,6 @@ export OKSHOT_PASSWORD=your_password
 export OKSHOT_URL_PREFIX=https://okshot.your_domain.ch
 #+end_example
 
-* EXAMPLES
-
-Add tags to a file. Tags are always unique.
-
-#+begin_example
-  $ touch foobar
-  $ okshot -a tag1 foobar
-  $ ls foobar*
-  foobar--[tag1]
-  $ okshot -a tag2 foobar--\[tag1\]
-  $ ls foobar*
-  foobar--[tag1,tag2]
-  $ okshot -a tag3,tag2 foobar--[tag1,tag2].pdf
-  $ ls foobar*
-  foobar--[tag1,tag2,tag3].pdf
-#+end_example
-
-Delete a tag from a file.
-
-#+begin_example
-  $ find . | grep business_card | head -n 1
-  ./archiv/Reto_Huber--[business_card,somedia,seo].pdf
-  $ okshot -d seo ./archiv/Reto_Huber--[business_card,somedia,seo].pdf
-  $ find . | grep business_card | head -n 1
-  ./archiv/Reto_Huber--[business_card,somedia].pdf
-#+end_example
-
-Interactively add tags (with auto-completion through readline) to a file.
-
-#+begin_example
-  $ okshot -i foo
-  > t[TAB]
-  tag1  tag2  tag3
-  > tag2, new tag
-  $ ls foo* | grep new
-  foo--[new_tag,tag2]
-#+end_example
-
-List all tags in the current folder.
-
-#+begin_example
-  $ touch foo
-  $ touch bar.txt
-  $ touch foobar--[tag1,tag2].pdf
-  $ touch baz--[tag1].txt
-  $ okshot -l
-  tag1(2)
-  tag2(1)
-#+end_example
-
-List all tags for a given path glob (assuming the same data set as above).
-
-#+begin_example
-  $ okshot -l '*txt'
-  tag1(1)
-#+end_example
-
-Rename tag.
-
-#+begin_example
-  $ okshot -l
-  200ok_expense(8)
-  business_card(4)
-  $ okshot -r 200ok_expense 200ok,expense
-  $ okshot -l
-  expense(8)
-  200ok(8)
-  business_card(4)
-#+end_example
-
-Search files with tags.
-
-#+begin_example
-  $ okshot -s somedia,seo,business_card
-  archiv/Reto_Huber--[business_card,seo,somedia].pdf
-  archiv/Reto_Huber--[business_card,seo,somedia].txt
-  $ okshot -s business_card '**/*pdf'
-  archiv/Reto_Huber--[business_card,seo,somedia].pdf
-  archiv/Stefan_Schmidt--[business_card,lawoon].pdf
-#+end_example
-
 * INSTALLATION
 
 =okshot= is implemented in [[https://www.ruby-lang.org/en/][Ruby]] and can be installed as a [[https://rubygems.org/][gem]].
@@ -131,8 +56,13 @@ Search files with tags.
     gem install okshot
   #+end_example
 
-It assumes you're using the [[https://i3wm.org/][i3wm]] tiling window manager and uses these
-standard Linux tools:
+It assumes you're using the [[https://i3wm.org/][i3wm]] tiling window manager and uses
+standard Linux tools. For all flags, it requires:
+
+- [[https://imagemagick.org/][imagemagick]]
+- [[https://linux.die.net/man/1/ftp][ftp]]
+
+For the flag =-i=, it additionally requires:
 
 - [[https://linux.die.net/man/1/wmctrl][wmctrl]]
 - [[https://inkscape.org/][inkscape]]
@@ -141,7 +71,7 @@ standard Linux tools:
 Install dependencies:
 
 #+begin_src shell
-apt-get install imagemagick inkscape wmctrl
+apt-get install imagemagick ftp inkscape wmctrl
 #+end_src
 
 * DEVELOPMENT
@@ -162,3 +92,6 @@ the =.gem= file to [[https://rubygems.org][rubygems.org]].
 
 # Tests are implemented with [[https://rspec.info/][RSpec]] and can be run with =bundle exec
 # rspec spec=.
+* DEMO
+
+[[https://github.com/200ok-ch/okshot/wiki/videos/demo.gif]]

data/bin/take_screenshot.sh

@@ -56,8 +56,10 @@ elif [[ $1 == -i ]]; then
   inkscape -o /tmp/$screenshot /tmp/$screenshot.svg
 
   rm /tmp/$screenshot.svg
-else
+elif [[ $1 == -s ]]; then
   import /tmp/$screenshot
+else
+  exit 1
 fi
 
 HOST=$OKSHOT_HOST

data/lib/ok/shot.rb

@@ -11,7 +11,7 @@ module OK
     class Error < StandardError; end
     extend self
 
-    def take_screenshot flag
+    def take_screenshot(flag)
       bin_dir = File.expand_path(File.join(%w[.. .. .. bin]), __FILE__)
       shell_script_path = File.join(bin_dir, "take_screenshot.sh -#{flag}")
       `#{shell_script_path}`
@@ -20,6 +20,14 @@ module OK
     def main
       OptionParser.new do |opts|
         opts.banner = 'Usage: okshot [options]'
+        opts.on(
+          '-s',
+          '--simple',
+          'Take a screenshot without annotation and upload'
+        ) do |c|
+          take_screenshot('s')
+          exit
+        end
         opts.on(
           '-c',
           '--copy-clipboard',

data/lib/ok/version.rb

@@ -1,5 +1,5 @@
 module OK
   module Shot
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: okshot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alain M. Lafon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-08 00:00:00.000000000 Z
+date: 2021-01-09 00:00:00.000000000 Z
 dependencies: []
 description: Take and annotate screenshots in Linux with standard tools.
 email:
@@ -54,8 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Take and annotate screenshots.