hugo-notion 0.1.0.pre.alpha.3 → 0.1.0.pre.alpha.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 998722740c86d07e77edb0bcfa625cf6cd9c956f90a525cf1146604324ed26bd
-  data.tar.gz: 596a6adb5d21930ea0a46beb2a4cd7e1a3d309d18f2dd2ade153e9d8414f70e5
+  metadata.gz: fd3187060a3da73b91950b528a29eba70a35d397a9855dd0eeddd581ba67981c
+  data.tar.gz: 80a7ef596ed857945e49c82514e30b5455add7e9b970387a0ecc1dd81b294af2
 SHA512:
-  metadata.gz: d44e9c969c40cdcbabcfd0442aa7577b54c31865910dc4cf51a268545f8fd1c76e705c64540e6e678284e48782227cf17dd048ccffd7793d17171b5222ea9f84
-  data.tar.gz: 6269bf536477e430f23912f0cc23e1b5a4a4eeb184e64afb38a918efbd602eb678b0d5776dbb383e960cd42f8d607f11caf703a76be26e62ea253c0fb323d423
+  metadata.gz: f935964859cefced056b4fa473f4a42824a73c8d79acc7456998f00cc3b3597a600390b8033ee87f84359df0801a310b186836315d630a99b4284e69f198112c
+  data.tar.gz: a16abdcaed50acb78625723ed45f4ea64f75a021b7ac5473ee51918c1e28c9f8a0a9e53e9562129898965b5ad4a3eb839ecaec7a0be515119306aaf4af04a4bb

data/README.md

@@ -1,3 +1,50 @@
 # hugo-notion
 
 Write in Notion. Publish with Hugo.
+
+## Installation
+
+```
+gem install hugo-notion --prerelease
+```
+
+Installing the `hugo-notion` ruby gem will install the `huno` command.
+
+## Usage
+
+First, create a Notion integration, generate a secret and connect that integration to the Notion page https://developers.notion.com/docs/create-a-notion-integration#getting-started
+
+Go to your Hugo site directory and run
+
+```
+NOTION_TOKEN=your_notion_secret huno your_notion_page_url
+```
+
+`huno` will sync your Notion page and its children pages to the `content` directory.
+
+If you're yet to move your Hugo pages to Notion, you can use my "blog_content" Notion page as a template https://www.notion.so/blog_content-0f1b55769779411a95df1ee9b4b070c9
+
+To avoid having to provide the notion token and notion page url again and again, create an .env file
+
+```
+echo 'NOTION_TOKEN=your_notion_secret' > .env
+echo 'CONTENT_NOTION_URL=your_notion_page_url >> .env'
+```
+
+## Tips
+
+To run `huno` say, every 15 seconds, use the `watch` command
+
+```
+watch -n15 huno
+```
+
+If you're on MacOS and don't have the `watch` command installed, you can use Homebrew to install it
+
+```
+brew install watch
+```
+
+## Bug Reports
+
+If you'd like to report a bug (if there are any, please do), please create a GitHub issue

data/bin/huno

@@ -1,32 +1,43 @@
 #!/usr/bin/env ruby
 
-require_relative '../lib/hugo_notion/synchronizer'
-
-def do_exit
-  puts 'Exiting...'
-  exit
+env_file_path = File.join(Dir.pwd, '.env')
+if File.exist?(env_file_path)
+  require 'dotenv'
+  Dotenv.load(env_file_path)
+end
+notion_token = ENV['NOTION_TOKEN']
+unless notion_token
+  throw "Please create a Notion integration, generate a secret and provide it in the 'NOTION_TOKEN' environment variable"
 end
-Signal.trap("TERM") { do_exit }
-Signal.trap("INT") { do_exit }
 
-if !ARGV[0]
-  puts "Please provide the URL of the Notion page you'd like to sync as the first argument"
+content_notion_url = if ARGV[0]
+  ARGV[0]
+else
+  ENV.fetch('CONTENT_NOTION_URL')
 end
-notion_page_url = ARGV[0]
-notion_page_id = URI(notion_page_url).path.match(/-(?<page_id>.*)\z/)['page_id']
+unless content_notion_url
+  throw "Please provide the URL of the Notion page you'd like to sync in the `CONTENT_NOTION_URL` environment variable or as the first argument"
+end
+notion_page_id = URI(content_notion_url).path.match(/-(?<page_id>.*)\z/)['page_id']
 
-destination_dir = File.join(Dir.pwd, 'content')
+content_dir = File.join(Dir.pwd, 'content')
 if ARGV[1]
-  if Pathname.new(ARGV[1]).absolute?
-    destination_dir = ARGV[1]
-  else
-    destination_dir = File.join(Dir.pwd, ARGV[1])
-  end
+  content_dir = ARGV[1]
+elsif ENV.fetch('CONTENT_DIR')
+  content_dir = ENV.fetch('CONTENT_DIR')
 end
+content_dir = File.expand_path(content_dir, Dir.pwd)
 
-puts "Syncing posts from Notion..."
+require_relative '../lib/hugo_notion/synchronizer'
+def do_exit
+  puts 'Exiting...'
+  exit
+end
+Signal.trap("TERM") { do_exit }
+Signal.trap("INT") { do_exit }
+puts "Syncing content from Notion..."
 Synchronizer.run(
   notion_page_id: notion_page_id,
-  destination_dir: destination_dir
+  destination_dir: content_dir
 )
 puts "Done."

data/lib/hugo_notion/synchronizer.rb

@@ -1,20 +1,7 @@
-env_file_path = File.join(Dir.pwd, '.env')
-if File.exist?(env_file_path)
-  require 'dotenv'
-  Dotenv.load(env_file_path)
-end
-notion_token = ENV['NOTION_TOKEN']
-unless notion_token
-  throw "Please create a Notion integration, generate a secret and provide it in the 'NOTION_TOKEN' environment variable"
-end
-
-NOTION_TOKEN = ENV['NOTION_TOKEN']
-
 require 'httparty'
 require 'notion-ruby-client'
 require 'notion_to_md'
 require 'yaml'
-require 'pry'
 
 class NotionApi
   BASE_URL = "https://api.notion.com/v1"
@@ -51,7 +38,7 @@ class Synchronizer
       destination_dir = options[:destination_dir]
       Dir.mkdir(destination_dir) unless Dir.exist?(destination_dir)
 
-      notion = NotionApi.new(NOTION_TOKEN)
+      notion = NotionApi.new(ENV.fetch('NOTION_TOKEN'))
       response = if notion_database_id
         notion.post("/databases/#{notion_database_id}/query")
       elsif notion_page_id
@@ -107,7 +94,7 @@ class Synchronizer
         end
 
         page_front_matter_yaml = page_front_matter.to_yaml.chomp
-        page_markdown = NotionToMd.convert(page_id: notion_block_id, token: NOTION_TOKEN)
+        page_markdown = NotionToMd.convert(page_id: notion_block_id, token: ENV.fetch('NOTION_TOKEN'))
         page_content = <<-page_CONTENT
 #{page_front_matter_yaml}
 ---

data/lib/hugo_notion/version.rb

@@ -1,3 +1,3 @@
 class HugoNotion
-  VERSION = '0.1.0-alpha.3'
+  VERSION = '0.1.0-alpha.5'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hugo-notion
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.3
+  version: 0.1.0.pre.alpha.5
 platform: ruby
 authors:
 - Nisanth Chunduru
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-16 00:00:00.000000000 Z
+date: 2024-04-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Write in Notion. Publish with Hugo.
+description: Use Notion as a CMS (Content Management System) for your Hugo site
 email:
 - nisanth074@gmail.com
 executables:
@@ -79,7 +93,8 @@ files:
 - lib/hugo_notion/synchronizer.rb
 - lib/hugo_notion/version.rb
 homepage: https://github.com/nisanthchunduru/hugo-notion
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message:
 rdoc_options: []