Python: Githubでライブラリを公開する - オープンソースを作るその1

 プログラミングである程度基礎を覚えたら、そこから上のレベルアップ方法として、実際にコードを書くためにオープンソースに関わることが推奨されていたりする。ここで有名なライブラリにコミットするのもありだが、自分で書いたものをオープンソースソフトウェアとして立ち上げてしまうのもいいだろう。有名なライブラリはコミットのルールなどがあることを考えると多少敷居が高い。自作ならルールは自分で決められる。というわけで、自作のライブラリをオープンソースとして公開して、いろんな人に使ってもらえるようにブラッシュアップしていく方法の一つを記事にしていこうと思う。

 初回はまず、Githubで公開することから。
 今は多くのオープンソースがGithubで公開されている。ほかのCIサービスなどとも連携できるので、Githubにしておけばとりあえずいいんじゃない?と思う。そういうわけでGithubで公開する方法を説明する。ちなみにぼくの開発環境がWindowsなので、説明もその環境で。あとライブラリはPythonのものとしてやっていく。もうライブラリのコードは用意してある仮定でやっていく。

 最初に、Githubのデスクトップアプリを落としてきてインストール。「Github デスクトップ」で検索すれば出てくる。あとGithubのWebサイトで会員登録を済ませて、アプリケーションにアカウントを設定しておく。



 インストールしたアプリを起動して、ウィンドウ内左上にある「+」マークをクリックしてプロジェクトのディレクトリを作成する。



 ディレクトリを作ったらそこに、あらかじめ作ってあったライブラリのコードを入れる。コードを入れたら、Githubアプリケーションのウィンドウを見てみる。


 Changesが有効になっていて、コミットができるようになっているはず。コミットメッセージを入れて、コミットボタンをポチッと。これでプロジェクトの状態(ファイル配置、ファイル内容など)がセーブされたことになる。

 公開のためにもう一つ。ライセンスを用意する。とりあえず、「このライブラリの制限を緩くしていろんなところで使ってほしい」というならMITライセンスで構わないだろう。RubyのRailsとかJavaScriptのjQueryがMITだ。
 MITのライセンス文を探してlicense.txtという名前で保存して、プロジェクトルートに置く。置いたらさっきと同じようにGithubアプリケーションを使ってコミット。
MITライセンス文

 これまでのコミットではまだライブラリが公開されていない。Githubアプリケーションのプロジェクト画面の右上にPublishボタンがあるので、これを押して公開する。



 これでライブラリがオープンソースとして公開され、いろんな人の手に渡る準備ができた。次回以降で、いろんな人に使ってもらうための仕組みを整えていく。
 
comment: 0