fyodor 0.2.6 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dae694865dbdb0187906ad21b610ac7f9486819141f86392816a41fbe835f71c
-  data.tar.gz: 97c07e5ba51877015426221aed2158a20436f36d8afbca165b8433c20050e02a
+  metadata.gz: 02a743dcc50a2c528b31aa2d4208cb4f220cb7ee5ee7a1ab19d36ee701c38de5
+  data.tar.gz: 005baf6cf829812dc8f9ab1d9f5d2761ff3a610e607e11abed66e507f6eee649
 SHA512:
-  metadata.gz: ec0b9492639f2b77ba2523106db931b3363c42731cab3b456f83e6c7e91ccc6ec196d4cbe9d8798f62a5c452eed391fec521d7e8da56c537be51a224e93963bc
-  data.tar.gz: 359197fe0aeb85d76f1d025c2e3517a7fb02c60712989f79dd14be2004f50f3892a312b4114a3d29245d26a8f2e72f59dd4a2925c7c800f3dc63b435d63e4952
+  metadata.gz: d6b6b7784323ac398eb36a4321d23a558c632246d2a5199dec38a28bd22a60fc77b93b76a31f95586ce27aac34538c74da6332fc96b84d61ad1b8f104eba56de
+  data.tar.gz: 0b6f4ab38b109fc7d64914d8b90ba45d32185b625c66f0099abb95299c38c639d788ff552c6b412c11f6ddf656d7a6cd6e9bb1109d5a6a22b25b7a6ad9021bc5

data/README.md

@@ -8,7 +8,7 @@ This application parses `My Clippings.txt` from your Kindle and generates a mark
 
 [For samples of the output, click here.](docs/output_demo)
 
-To read more about the motivation and what problem it tries to solve, [check this blog post](http://rafaelc.org/blog/export-all-your-kindle-highlights-and-notes/).
+To read more about the motivation and what problem it tries to solve, [check this blog post](https://rafaelc.org/posts/export-all-your-kindle-highlights-and-notes/).
 
 ## Features
 
@@ -22,6 +22,13 @@ To read more about the motivation and what problem it tries to solve, [check thi
 
 This program is based on the clippings file generated by Kindle 2019, but should work with other models.
 
+## Limitations
+
+We are limited by the data Kindle makes available through `My Clippings.txt`. This means:
+
+- We don't have chapter information.
+- We can’t guess all entries that were deleted.
+
 ## Installation
 
 Install Ruby and run:
@@ -46,10 +53,10 @@ Fyodor has an optional configuration file, which is used for the following.
 
 If your Kindle is not in English, you should tell Fyodor how some things are called by your `My Clippings.txt` (e.g. highlights, pages, etc). _Fyodor should still work without configuration, but you won't take advantage of many features, resulting in a dirtier output._
 
-1. Download the sample config to `~/.config/fyodor.toml` or `$XDG_CONFIG_HOME/fyodor.toml`:
+1. Download the sample config to `~/.config/fyodor/fyodor.toml` or `$XDG_CONFIG_HOME/fyodor/fyodor.toml`:
 
-```
-$ wget https://raw.githubusercontent.com/rccavalcanti/fyodor/master/docs/fyodor.toml.sample -O ~/.config/fyodor.toml
+```sh
+$ curl https://raw.githubusercontent.com/rc2dev/fyodor/master/docs/fyodor.toml.sample --create-dirs -o ~/.config/fyodor/fyodor.toml
 ```
 
 2. Open both the configuration and your `My Clippings.txt` in your preferred editor. Change the values in the `[parser]` section to mirror what you get in `My Clippings.txt`.
@@ -82,6 +89,18 @@ Where:
 - `CLIPPINGS_FILE` is the path for `My Clippings.txt`.
 - `OUTPUT_DIR` is the directory to write the markdown files. If none is supplied, this will be `fyodor_output` under the current directory.
 
+## PSA: HTML to markdown
+
+Did you export your annotations to HTML using the Kindle mobile app?
+
+You can convert it to markdown with [a script I wrote specifically for it](https://rafaelc.org/k/kindle2md).
+
+## Buy me a coffee
+
+If you like Fyodor, you can show your support here:
+
+<a href="https://rafaelc.org/coffee" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" width="200" ></a>
+
 ## License
 
 Licensed under [GPLv3](LICENSE)

data/lib/fyodor/config_getter.rb

@@ -42,8 +42,8 @@ module Fyodor
       return @paths unless @paths.nil?
 
       @paths = []
-      @paths << Pathname.new(ENV["XDG_CONFIG_HOME"]) + "fyodor.toml" unless ENV["XDG_CONFIG_HOME"].nil?
-      @paths << Pathname.new("~/.config/fyodor.toml").expand_path
+      @paths << Pathname.new(ENV["XDG_CONFIG_HOME"]) + "fyodor/fyodor.toml" unless ENV["XDG_CONFIG_HOME"].nil?
+      @paths << Pathname.new("~/.config/fyodor/fyodor.toml").expand_path
     end
 
     def print_path

data/lib/fyodor/version.rb

@@ -1,3 +1,3 @@
 module Fyodor
-  VERSION = "0.2.6".freeze
+  VERSION = "0.2.10".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fyodor
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.10
 platform: ruby
 authors:
 - Rafael Cavalcanti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml
@@ -24,8 +24,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Parse Kindle clippings into markdown files
-email: code@rafaelc.org
+email: dev@rafaelc.org
 executables:
 - fyodor
 extensions: []
@@ -47,11 +61,11 @@ files:
 - lib/fyodor/stats_printer.rb
 - lib/fyodor/strings.rb
 - lib/fyodor/version.rb
-homepage: https://github.com/rccavalcanti/fyodor
+homepage: https://rafaelc.org/fyodor
 licenses:
 - GPL-3.0-only
 metadata:
-  source_code_uri: https://github.com/rccavalcanti/fyodor
+  source_code_uri: https://rafaelc.org/fyodor
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -61,6 +75,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="