notebroker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 966658274251d2f4ada02bd952ea13089c823290073ba9920abf7450aaa6f84b
-  data.tar.gz: 6efd22a408432c4d3becb0f06de6694366d86c93f633553730c3f19e03e89439
+  metadata.gz: 56b2b13742117077a4c4e7f2281eb59e9b4a4cdc6c3dda9a6454d2e058c5f7c6
+  data.tar.gz: d5c5fe760a5cf1e97d76c5d86ffea66f869ccb4c7402ce50c5a9127558c650c3
 SHA512:
-  metadata.gz: 9322946fac86264abc9e05431633c8923c822a85fdad23c66796cd97550e93fb8c2d79453d77822be142765ac072ae08691c5b0ebd06531154c7c27087df58d6
-  data.tar.gz: e13c1d6d050e531d1a355d624dc251f9165eb1bf212bcdd4659039ac1760e658fa21561d7ea7e0ffdacb055ff268a68da982e42e7348b426255471918056c43b
+  metadata.gz: 91bf3011d1a37a30c6f72ce6ff2e829274828e0af09155ee06a100e0ced214b18ab20f1d0db95c5afd4351a8d5f430a9019eabd1501f053862c68ee0af97a6fe
+  data.tar.gz: b50b06496b9af843f385851ff806c1fdf6905ea19226a17426cfaf3c4f0485fdefde8350a6a8d667d623ac9006437a92858690c4d83d0aba81e58a867fc308dc

data/Gemfile

@@ -4,6 +4,8 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "rake"
+
 group :development, :test do
   gem "byebug"
   gem "pry"

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    notebroker (0.1.0)
-      dry-cli
-      dry-initializer
+    notebroker (0.1.1)
+      dry-cli (~> 0.7.0)
+      dry-initializer (~> 3.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -33,6 +33,7 @@ GEM
       method_source (~> 1.0)
     racc (1.6.0)
     rainbow (3.1.1)
+    rake (13.0.6)
     regexp_parser (2.2.1)
     reverse_markdown (2.1.1)
       nokogiri
@@ -98,6 +99,7 @@ DEPENDENCIES
   byebug
   notebroker!
   pry
+  rake
   rspec
   rubocop
   rubocop-performance

data/README.md

@@ -43,6 +43,152 @@ Converting notebooks/my-notebook.ipynb into markdown...
 Saved markdown file to ./
 ```
 
+## Formatting
+
+This is an example of the input and converted markdown file generated:
+
+### Input
+
+```json
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "3715d426-5951-4b56-b202-2457e1f7742f",
+   "metadata": {},
+   "source": [
+    "# Test file 1\n",
+    "\n",
+    "This is the first line.\n",
+    "\n",
+    "This is the end of the first section"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "206fb993-c482-49fa-aa50-95aa25dcff71",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import code\n",
+    "\n",
+    "def a_function(some_parameter):\n",
+    "    return some_parameter\n",
+    "\n",
+    "def calculate_something(n):\n",
+    "    '''\n",
+    "    this is a comment\n",
+    "    '''\n",
+    "    \n",
+    "    # This is another comment\n",
+    "    return something"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b09f90d3-97f1-4ed4-903e-4e62060e35e5",
+   "metadata": {},
+   "source": [
+    "## Subheader: The third cell\n",
+    "\n",
+    "A single line in the third cell\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "bea26222-75b8-4cf6-9367-52c94344dd8e",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "This is the result of a cell\n",
+      "----------------------------------------\n",
+      "Total amount paid will be $251,717.22\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(\"This is the result of a cell\")\n",
+    "print(\"Total amount paid will be ${:,.2f}\".format(total_amount))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "477b0f9b-5d79-4275-966b-4ef38a6dfc2d",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.10"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}
+```
+
+### Output
+
+````markdown
+# Test file 1
+
+This is the first line.
+
+This is the end of the first section
+
+``python
+import code
+
+def a_function(some_parameter):
+    return some_parameter
+
+def calculate_something(n):
+    '''
+    this is a comment
+    '''
+    
+    # This is another comment
+    return something
+```
+
+## Subheader: The third cell
+
+A single line in the third cell
+
+```python
+print("This is the result of a cell")
+print("Total amount paid will be ${:,.2f}".format(total_amount))
+```
+
+```shell
+This is the result of a cell
+----------------------------------------
+Total amount paid will be $251,717.22
+```
+````
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/notebroker

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "notebroker"
+
+Dry::CLI.new(Notebroker::CLI::Commands).call

data/lib/notebroker/markdown.rb

@@ -9,7 +9,6 @@ module Notebroker
 
     param :source
 
-    # @param String
     def call
       parsed = JSON.parse(source, symbolize_names: true)
       result = Lexer.call(parsed[:cells])

data/lib/notebroker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Notebroker
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/notebroker.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/notebroker/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "notebroker"
+  spec.version = Notebroker::VERSION
+  spec.authors = ["Nolan J Tait"]
+  spec.email = ["nolanjtait@gmail.com"]
+
+  spec.summary = "A gem for turning notebooks into other formats"
+  spec.description = "A ruby based CLI to turn python notebook ipynb files into other formats"
+  spec.homepage = "https://github.com/nolantait/notebroker"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) ||
+        f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r(\Aexe/)) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "dry-cli", "~> 0.7.0"
+  spec.add_dependency "dry-initializer", "~> 3.1.1"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notebroker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nolan J Tait
@@ -41,7 +41,8 @@ dependencies:
 description: A ruby based CLI to turn python notebook ipynb files into other formats
 email:
 - nolanjtait@gmail.com
-executables: []
+executables:
+- notebroker
 extensions: []
 extra_rdoc_files: []
 files:
@@ -53,6 +54,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/notebroker
 - lib/notebroker.rb
 - lib/notebroker/callable.rb
 - lib/notebroker/cells/code.rb
@@ -62,6 +64,7 @@ files:
 - lib/notebroker/lexer.rb
 - lib/notebroker/markdown.rb
 - lib/notebroker/version.rb
+- notebroker.gemspec
 homepage: https://github.com/nolantait/notebroker
 licenses:
 - MIT