nb_util 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e89059de6fc29a9e2e4aa276121bce5c2b3561342cde2c5305af6e50223a1e08
+  data.tar.gz: 6dd435ec22e2f0b40bae1062e86accdb73aa70ccbca0f8c9d30fd40d99846a32
+SHA512:
+  metadata.gz: a15b050b6c57985ce86f798e9af90e13693f37b268ceb1b473efd4f7df99f8761fb0a2c0410aad6e9cfe4800ae8db340645079467d78f3bfd63cede1918cb772
+  data.tar.gz: 401ea7f2a31c4cdfa71bb875ac45db1cf41039ba9e6c4c1afd8c642186f884921f6de539336802779601991f079525fccc3a24da7f363cb239debc8a286bdb00

data/.gitignore

@@ -0,0 +1,12 @@
+/.DS_Store/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+/.ipynb_checkpoints/
+*~
+#*

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.rspec_status

@@ -0,0 +1,4 @@
+example_id                  | status | run_time        |
+--------------------------- | ------ | --------------- |
+./spec/nb_util_spec.rb[1:1] | passed | 0.0024 seconds  |
+./spec/nb_util_spec.rb[1:2] | failed | 0.03039 seconds |

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ferrari.race.beautiful@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nb_util.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 EAGLE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Name
+Nb_Util
+
+# Summary
+This gem makes and supplies user specific helps, emulating CUI(CLI) help usage.
+
+# Usage
+
+```ruby
+gem 'nb_util'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nb_util
+
+
+# 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/EAGLE12/nb_util. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+# License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+# Code of Conduct
+
+Everyone interacting in the NbUtil project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/EAGLE12/nb_util/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'open3'
+
+RSpec::Core::RakeTask.new(:spec)
+
+#task :default => :spec
+task :default do
+  system 'rake -T'
+end
+
+desc "open github origin url"
+task :open_github do
+  out, err, status = Open3.capture3("git remote -v")
+  url = "https://"+out.match(/^origin\s+git@(.+) \(fetch\)/)[1].gsub(':','/')
+  system "open #{url}"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nb_util"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/.ipynb_checkpoints/abst-checkpoint.ipynb

@@ -0,0 +1,228 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "toc": "true"
+   },
+   "source": [
+    "# Table of Contents\n",
+    " <p><div class=\"lev2 toc-item\"><a href=\"#step1-方策\" data-toc-modified-id=\"step1-方策-01\"><span class=\"toc-item-num\">0.1&nbsp;&nbsp;</span>step1 方策</a></div><div class=\"lev2 toc-item\"><a href=\"#背景\" data-toc-modified-id=\"背景-02\"><span class=\"toc-item-num\">0.2&nbsp;&nbsp;</span>背景</a></div><div class=\"lev2 toc-item\"><a href=\"#目的\" data-toc-modified-id=\"目的-03\"><span class=\"toc-item-num\">0.3&nbsp;&nbsp;</span>目的</a></div><div class=\"lev2 toc-item\"><a href=\"#手法\" data-toc-modified-id=\"手法-04\"><span class=\"toc-item-num\">0.4&nbsp;&nbsp;</span>手法</a></div><div class=\"lev2 toc-item\"><a href=\"#今後\" data-toc-modified-id=\"今後-05\"><span class=\"toc-item-num\">0.5&nbsp;&nbsp;</span>今後</a></div>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## step1 方策\n",
+    "\n",
+    "目標:今作ったようなツールをnbutilsとしてrubyのcliで作る\n",
+    "\n",
+    "仕様:\n",
+    "* nbutils rename *.png mid[].png\n",
+    "* ...\n",
+    "* [github](https://github.com/daddygongon/notebook_root) に入れてるんで，そのあたり読んで，manualを作れ．(10/25発表)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 背景\n",
+    "\n",
+    "暗黙知の形式知化はいくつものシステムで行われている．\n",
+    "ウェブ検索でよく上位に出てくるQiita.comや個人ブログなど，\n",
+    "自分の知恵をまとめて提供している．\n",
+    "本研究室には，ユーザーメモソフトmy\\_helpというものがある．\n",
+    "これは，本研究室西谷が開発したものであり，\n",
+    "terminal上で使用するため，\n",
+    "自然とCUI(Character User Interface)スキルを身に付けることができる．\n",
+    "更に，terminalから離れることなくメモを残すことができるので，\n",
+    "書きたい内容を忘れず，すぐに書くことができる．\n",
+    "自分自身が大切だと思いメモをした内容は，\n",
+    "研究室のメンバーまたは，同じ方向に向かって何かに取り組んでいる者にとっては，\n",
+    "有益かつ共有したい情報である．\n",
+    "\n",
+    "また研究室のメンバーがメモ(暗黙知)をした内容を，\n",
+    "ゼミを欠席した者に共有したくても\n",
+    "そのメモは所有者個人しか閲覧することができない．\n",
+    "更にこのメモを共有するために\n",
+    "清書(形式知化)する際，通常メモと異なったフォーマットで記述されるため，\n",
+    "一つの箇所に修正があると全てに対応しなければならなくなる．\n",
+    "メモの量が，数が少なければ\n",
+    "手作業で変換することは可能だが，\n",
+    "メモの数が増え，それを手作業でやっていては手間も時間も掛かり，\n",
+    "それだけでなく誤りも起きやすくなる．\n",
+    "これは，プログラマの心得である，DRY(Don't Repeat Yourself)原則を破ることになる\\cite{pragmatic_prog}．\n",
+    "したがって，可能な限り自動化すべきである．\n",
+    "\n",
+    "![no1](./figs/mid03.png)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 目的\n",
+    "本研究では，my¥_helpのデータを\n",
+    "Jupyter notebookで扱える形式に自動変換するシステムを構築する．\n",
+    "\n",
+    "手間と時間が掛からずに，\n",
+    "更に間違いなく清書し共有することができるようになることで，\n",
+    "その日のゼミの内容を欠席した者にも正確に伝えることができる．\n",
+    "加えて，自分が調べた内容も，\n",
+    "研究室のメンバーと容易に共有できるようにすることができる．"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 手法\n",
+    "Jupyter notebookは，プログラムに関係するメモや，\n",
+    "出力結果をひとまとまりに保存する機能を持ち，\n",
+    "Githubなどのサービスで，共有することができるシステムである．\n",
+    "ノートブックと呼ばれる形式にドキュメントを作成し，\n",
+    "プログラムの記述と実行，メモなどを作成し，\n",
+    "ブラウザー上で動作する対話型実行環境である¥cite{Jupyter}．\n",
+    "西谷研究室では，\n",
+    "個々の研究内容をバックアップするためにGithubを使用しており，\n",
+    "西谷からの情報もそこに公開されている．\n",
+    "その為，西谷研の学生はどこからでもアクセスし，\n",
+    "好きなタイミングで自分の情報を更新することが可能である．\n",
+    "そこで，自分のmy¥_helpにあるメモを図1のように\n",
+    "my¥_helpからJupyter notebookに変換するシステムを構築することで，\n",
+    "メモからノートに自動変換が可能になり，\n",
+    "my¥_helpとJupyter notebookの連携ができるようになる．\n",
+    "更に，\n",
+    "Jupyter notebookにあるGithubとの連携機能を使用することで，\n",
+    "今まで個人のメモであったものが，\n",
+    "その情報を必要としている複数の人に，\n",
+    "共有することができる．\n",
+    "\n",
+    "my¥_helpのメモは，yaml形式で書かれており，\n",
+    "Jupyter notebookはjsonで書かれている．\n",
+    "yamlからjsonのフォーマット変換を行うことで，\n",
+    "my¥_help to Jupyter notebookを実現する．"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 今後\n",
+    "現状上記の変換コードは，プロトタイプとして変換を確認している．\n",
+    "しかし，\n",
+    "変換した際に，my¥_helpに書かれているメモをどのようなフォーマットで\n",
+    "Jupyter notebookに表示させるかの指定が出来ていない．\n",
+    "また，共有に際して便利な機能として，\n",
+    "ランク付け，コメント，要望などがある．\n",
+    "これらは，Githubが提供するforkおよびpull requestの機能で\n",
+    "実現されているため，それらを利用するシステムを今後構築していく．\n",
+    "更に，my¥_helpからJupyter notebookへ変換を実行するコマンドが各自の環境に必要である．\n",
+    "これらの作業を管理者が行うシステムへ変更していく．"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": true
+   },
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Ruby 2.2.2",
+   "language": "ruby",
+   "name": "ruby"
+  },
+  "language_info": {
+   "file_extension": ".rb",
+   "mimetype": "application/x-ruby",
+   "name": "ruby",
+   "version": "2.2.2"
+  },
+  "latex_envs": {
+   "LaTeX_envs_menu_present": true,
+   "autocomplete": true,
+   "bibliofile": "biblio.bib",
+   "cite_by": "apalike",
+   "current_citInitial": 1,
+   "eqLabelWithNumbers": true,
+   "eqNumInitial": 1,
+   "hotkeys": {
+    "equation": "Ctrl-E",
+    "itemize": "Ctrl-I"
+   },
+   "labels_anchors": false,
+   "latex_user_defs": false,
+   "report_style_numbering": false,
+   "user_envs_cfg": false
+  },
+  "toc": {
+   "colors": {
+    "hover_highlight": "#DAA520",
+    "navigate_num": "#000000",
+    "navigate_text": "#333333",
+    "running_highlight": "#FF0000",
+    "selected_highlight": "#FFD700",
+    "sidebar_border": "#EEEEEE",
+    "wrapper_background": "#FFFFFF"
+   },
+   "moveMenuLeft": true,
+   "nav_menu": {
+    "height": "102px",
+    "width": "252px"
+   },
+   "navigate_menu": true,
+   "number_sections": true,
+   "sideBar": true,
+   "threshold": 4,
+   "toc_cell": true,
+   "toc_position": {
+    "height": "814px",
+    "left": "0px",
+    "right": "1700px",
+    "top": "206px",
+    "width": "220px"
+   },
+   "toc_section_display": "block",
+   "toc_window_display": true,
+   "widenNotebook": false
+  },
+  "varInspector": {
+   "cols": {
+    "lenName": 16,
+    "lenType": 16,
+    "lenVar": 40
+   },
+   "kernels_config": {
+    "python": {
+     "delete_cmd_postfix": "",
+     "delete_cmd_prefix": "del ",
+     "library": "var_list.py",
+     "varRefreshCmd": "print(var_dic_list())"
+    },
+    "r": {
+     "delete_cmd_postfix": ") ",
+     "delete_cmd_prefix": "rm(",
+     "library": "var_list.r",
+     "varRefreshCmd": "cat(var_dic_list()) "
+    }
+   },
+   "types_to_exclude": [
+    "module",
+    "function",
+    "builtin_function_or_method",
+    "instance",
+    "_Feature"
+   ],
+   "window_display": false
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}