#はじめに
最初は LAMP+Wordpress+Python(Django)のセットアップメモ2018 にVisualStudio環境構築についてをまとめたろうとしたけど、なんでか github からロードしたときに実行できないので、slack の pythonjp(ビギナー用スレ)に相談してみたらなるほどなぁという答えが返ってきた。しかし、当初のファイル構成と異なってくるため、 LAMP+Wordpress+Python(Django)のセットアップメモ2018 には混ぜ込まずに新記事としてまとめることにした。
ずっとviの黒い画面でゴリゴリやってきたけど、ちょっと立ち止まって作業環境を整えることは重要だよね。
#VisualStudio2017 ➡ Github の一方通行にしろ
Slack(pythonjp)での会話
(yoshitaka)
みなさんのなかで開発環境にVisualStudioを使ってらっしゃる方はいますか?現在私はTeratermごしに、さくらのVPSの環境を直接 vi でいじる形で編集して(いまのところ)それなりに試作はうまくいっていて、githubに上げるようなこともしています。が、これをローカルPCのVisualStudio(以下VS)に持ってこようとしたときに、うまく動かせない状況に悩まされています。プレーンなDjangoプロジェクトをVSで新規作成するとデモページは表示されるけど、githubからロードしたときにはうまくいかない...いわばずっと本番環境で切った貼ったしてる状態というのは普通の開発では無いと思うので、開発環境⇔本番環境のキャッチボールってみなさんこのへんどうしてるのかなと思って質問します。VSのコードヒントとか使えると安心感が全然違うのでできればviじゃなくてこっちでやりたい...。そういうのが書いてある本でもあったら教えてもらえるとうれしいです
(d-okuno)
回答になっていないかもですが、弊社で行なっている
全体の流れだけ記載します。
通常時は開発環境→本番環境の一方向になります。
●本番環境→開発環境(弊社ではやっていませんが)
1.本番環境でpip freeze > requirements.txtのように依存ライブラリを書き出し
2.開発環境にファイルを全て取得
3.開発環境でvirtualenv等で該当プロジェクトの環境を作成
4.上記virtualenv内でpip install -r requiments.txtみたいな感じで本番環境と同じ依存ライブラリをインストール
5.IDEの設定(弊社ではIntellijを利用しているため、VisualStudioの設定がわかりませんが、少なくともIntellijではSDKとして、上記のvirtualenvを設定とsettings.pyのパスを通す必要がありますので、VisualStudioでも同じ様な対応が必要と思います。)
6.開発開始
(本番と開発のsettings.pyは分けています。開発ではsqlite 本番ではAzureSQLデータベースの様に)
●開発環境→本番環境
1.ソースを修正しBitbucketやgithubなどにpush
2.Azure等では紐付けるリポジトリとブランチが設定できるため、自動デプロイとなります。
(デプロイのスクリプトは別途用意)
以下さくらVPSの自動デプロイの記事の様です。
https://qiita.com/abeyuya/items/773c26384297efe1f9a1
(yoshitaka)
ははぁ〜。大変参考になります。
たしかに一方通行がいいような気がします。
さんざんスクラップアンドビルドもして、書くべき場所もわかるようになったので問題なしです。思った以上の回答が得られました。感謝します。きっと会社によってもやり方違うんでしょうねぇ。やっぱりsettingsも別物なんですね。しかし、本番⇔開発ってよくありそうだからもっと簡単なステップであってもおかしくないような気もしますがまだまだこれからの話なんでしょうねぇ。
(ishimoto)
Visual Studioについては書いてありませんが、一般的なWebアプリ開発については Pythonプロフェッショナルプログラミング第3版 にも解説があります。チームでの開発を行うための解説書なので、個人開発ではあまり必要がない部分も多いかもしれませんが。。。
(yoshitaka)
ありがとうございます。pythonの本は結構買ったつもりでしたがなぜかこれが漏れてました。ちょっと本屋で見て買う方向でいきたいと思います
#やりたいこと
このキャッチボールよね。vi(本番環境)とVisualStudio(開発環境)
#CentOSでのファイル構成
いままでCentOSで作ってきたファイル構成はこんな感じだったでしょう?
$ tree
.
┗ pj1
┣ app1
┃ ┣ admin.py
┃ ┣ apps.py
┃ ┣ forms.py
┃ ┣ migrations
┃ ┣ models.py
┃ ┣ static
┃ ┃ ┣ css
┃ ┃ ┃ ┗ styles.css
┃ ┃ ┣ files
┃ ┃ ┃ ┗ sample.csv
┃ ┃ ┗ js
┃ ┃ ┗ radarChart.js
┃ ┣ templates
┃ ┃ ┗ index.html
┃ ┣ tests.py
┃ ┣ urls.py
┃ ┗ views.py
┣ manage.py
┗ pj1
┣ __init__.py
┣ settings.py
┣ urls.py
┗ wsgi.py
githubにも、この public_html 配下のファイル構成をアップロードしています
#Windowsを再インストールしたときのメモ
VisualStudioをインストールして初回にDjangoやるときはDjangoが古いと思うのでdjangoをインストールしよう
##No module named 'django'
HDDトラブルがあってクリーンインストールから環境再現したあと、実行が失敗するようになった。結論から言うと画像の通り「pip install django」と入れれば良かったんだけど、なんだかエライ時間取られたなぁ
##パスを通す
環境変数PATHを設定する
勘所は2カ所のpathを登録するということとPythonがある位置とプロジェクトファイルのある位置を混同しないこと
###1.python.exeの位置を特定
・C:\Program Files (x86)\Microsoft Visual Studio\Shared\Anaconda3_64
###2.環境変数の登録
・Python.exe のあるフォルダ
・Scripts フォルダを登録
・最後の円マークは不要
・Windows再起動(重要)
#VisualStudioでのファイル構成
staticフォルダとかtemplatesフォルダのなかで、appのフォルダを切る(赤い矢印)っていうのは僕がわかりやすさのためにやってなかっただけで、公式の推奨されたやり方ではあるから別にいいんだけど(pj1のなかでapp1、app2...とか増えてったときにアプリケーション名のフォルダを切らないとテンプレートの違いをDjangoが識別できない)、まぁそれはそれで文化としてこっちに慣れておいたほうがいい。やっぱりVisualStudioにしかない(しかしCentOS側では不要な)ファイルってのがどうもあるんだよね(緑の矢印)
#VisualStudioにしかないファイルという誤解
##ただのWindowsエクスプローラ?
いや、よく見るとGithubから落としてきて、そのフォルダを開いている状態だとだめで、.slnをダブルクリックしてなかに入り込んで実行するとうまくいくんだ。なんだこれよくわかんねぇな
##VisualStudioの基本?
と思ったら、あぁ~!VisualStudioが「こいつただのフォルダ見てんな?俺はそいつはしらねーよ」ってなってただけなのか。あくまでソリューションファイルを起点にしたいと。
http://www.atmarkit.co.jp/ait/articles/1704/21/news018_3.html
VS 2017ではアプリ開発に必要となる情報をさまざまなファイルに保存しながら、それらをプロジェクトやソリューションといった論理的なグループにまとめて管理をしている。フォルダビューは、そうではなくフォルダ構造をダイレクトにソリューションエクスプローラーに表示するものだ。ここで見ているWindowsフォームアプリなどではこのビューの使い道はあまりない
あぁ~なんかスッと整理が進んで勉強になったわ
#GithubからのCloneの場合
さっきも書いたとおり、おそらくフォルダビューという、単なるWindowsエクスプローラが表示されているので、ソリューションからの表示に切り替えましょう。
#VisualStudioからの新規作成の場合
##Githubにリポジトリを新規作成
「Visualstudio-Django」とする
##任意の場所にカラフォルダを作成
プロジェクト作ったばっかの時は temp 領域にあるらしい
カラのフォルダを作って(ここでは「Visualstudio-Django」とする)
##ローカルGitリポジトリの指定
「新しいリポジトリ」を「Visualstudio-Django」に書き換えて「作成」
(さっき作ったカラのフォルダを指定した状態)
フェッチのところは、いつものgithubのリポジトリURLをコピってくる
コミットメッセージは「first commit」とする
「+」のマークを押すとステージングされる
まだコミットされただけだ(githubにはpushされていない)
#ようやくだ。。。
Visualstudioを使う人が少ないのか、全然参考に出来るところがなかった...つら。
#ソースコードを再現する
「構造」は一緒だからね。かんたんかんたん。
##トラブルシューティング
###VisualStudioからpipをアップデート
...みたいなのをやってもダメなんだよなぁ~
原因は DjangoでrunserverしたらImportError: cannot import name includeが出た。 のあたりだと思うけど。
###ん?Djangoが1.1??
ひょっとして根元のライブラリインストールとかはDOSプロンプトからやんないといけないの?とかげんなりしながらまた1週間が過ぎた...ら気がついた。1.1???
どうやら condaとpip:混ぜるな危険 この辺っぽいなぁ。原因が。そうそう。たしかに僕がAnacondaを使い始めるきっかけになったのもこういう感じ(参考)。
筆者がPythonを使い始めた頃 (2013~2014年ぐらい)はPythonの公式側でパッケージ管理の仕組みがまだ整備途中の段階だった。特にWindowsではnumpyの様な(他言語で書かれたライブラリのコンパイルを伴う)パッケージをpipから入れるのは難しかった。そのため、非公式サイトからビルド済のファイルを逐一ダウンロードする必要があるなど不便が多かった。
Anacondaではその辺の不便が解消されており、当時から一発で必要なパッケージをすべてインストールできた(今となっては大半のパッケージがpipで入れられるように整備されている)。
・pipからしか入れられないパッケージを入れたい場合、新しいcondaの環境を作る(conda create -n env python)。その環境内ではconda installは一切用いない。
・Anacondaを使うのをやめる。Python公式サイトのPythonを使い、パッケージはpipで導入する。仮想環境についてはvenvやvirtualenvを用いる。
あれ?ということはいまはAnaconda使わなくてもプレーンなpythonセットアップでどうにかなりそうってことなのかい?
まぁこの辺の検証はあとだな。
現在のエラーはこんな画面。テーブルが見つけられない、なのでステップは進んだということだ。
#sqlite3のセットアップ
データベースのセットアップ
Microsoft公式:Django 管理コンソール
##コンソールは無い!
CentOSでうにゃうにゃやってたコンソールが無ぇと migrate とかできねーじゃん?まじかよ Visualstudio で全部操作しきらないとはなんという片手落ち...。あくまで Python Tools for Visual Studio だからなの?
##しょうがねー、やるか
あぁ~、もうすっかり「ls」とかのコマンドがしみ込んでてMS-DOSやりにくーい
~> cd C:\Users\Yoshitaka\Documents\Visual Studio 2017\Projects\Visualstudio-Django\pj
~Visualstudio-Django\pj> dir
ドライブ C のボリューム ラベルがありません。
ボリューム シリアル番号は 9A6A-D401 です
C:\Users\Yoshitaka\Documents\Visual Studio 2017\Projects\Visualstudio-Django\pj のディレクトリ
2018/07/24 22:27 <DIR> .
2018/07/24 22:27 <DIR> ..
2018/07/30 20:20 <DIR> app
2018/07/16 23:25 40,960 db.sqlite3
2018/07/21 15:32 340 manage.py
2018/07/24 22:27 <DIR> obj
2018/07/24 22:52 <DIR> pj
2018/07/24 22:46 6,149 pj.pyproj
2018/07/21 15:34 254 pj.pyproj.user
2018/07/21 15:34 1,102 pj.sln
2018/07/16 23:25 28,423 readme.html
2018/07/16 23:25 18 requirements.txt
7 個のファイル 77,246 バイト
5 個のディレクトリ 52,488,470,528 バイトの空き領域
###おぉん?
~Visualstudio-Django\pj> python
'python' は、内部コマンドまたは外部コマンド、
操作可能なプログラムまたはバッチ ファイルとして認識されていません。
###Pythonがある位置とプロジェクトファイルのある位置が違う
ギューっと狭い視点になると沼にハマる
###1.pythonがある位置にパス(環境変数)を通す
環境変数PATHを設定する
###2.Migrate!(キタぞ!)
通ったーー!!!
WindowsでのPythonって鬼門すぎるだろ...www
~> cd C:\Users\Yoshitaka\Documents\Visual Studio 2017\Projects\Visualstudio-Django\pj
~Visualstudio-Django\pj> python manage.py makemigrations app
Migrations for 'app':
app\migrations\0001_initial.py
- Create model evaluation
~Visualstudio-Django\pj> python manage.py migrate
Operations to perform:
Apply all migrations: admin, app, auth, contenttypes, sessions
Running migrations:
Applying app.0001_initial... OK
###3.VisualStudioから実行!
Github(CentOS版)から鬼のようなコピペで一気に再現。一部つっかえたけど(app1➡appなど)サクサク解決。
##ファイルアップロードができない??
discord(pythonjp)に相談する直前のメモがあるので貼り付けよう
追加で相談させてください。
おかげさまでVisualStudioでの開始ボタンを押してブラウザでdbテーブルの内容を表示するところまでいきました。
が、CentOS版(※ここにURL)を見ていただくとわかると思うんですが、テーブルにCSVからInsertするボタンがあって、それを試そうとしたときに落ちました。
※以下「\\」を「¥¥」に読み替えてください
(そんなディレクトリはねーよ)
[Errno 2] No such file or directory: 'C:\\Users\\Yoshitaka\\Documents\\Visual Studio 2017\\Projects\\Visualstudio-Django\\pj\\app/static/files/sample.csv'
views.pyはどうなっているか。じつはこの書き方でCentOS版は正しいパスが返るが、結果的にはスラッシュのバックスラッシュの混在が起こっている
UPLOAD_DIR = os.path.dirname(os.path.abspath(file)) + '/static/files/'
実際に返ったパスを、Windowsエクスプローラーで追いかけてみるも当然怒られる
C:\\Users\\Yoshitaka\\Documents\\Visual Studio 2017\\Projects\\Visualstudio-Django\\pj
\を削ってWindowsエクスプローラーで追いかけてみる。当然表示される
C:\Users\Yoshitaka\Documents\Visual Studio 2017\Projects\Visualstudio-Django\pj
今回もWindwowsの鬼門のような気がしていて、この記述を変更してしまうとCentOSとの整合性が取れなくなりそうです。
UPLOAD_DIR = os.path.dirname(os.path.abspath(file)) + '/static/files/'
これは、、、解決する方法があるんですかね、、、
###解決の結論としては、CentOSのほうを直そうと決めた
os.path.joinでOS間の垣根をなくして解決!
Python、os.path.joinでパスを結合する
UPLOAD_DIR = os.path.dirname(os.path.abspath(__file__)) + '/static/files/'
UPLOAD_DIR = os.path.join( os.path.dirname(os.path.abspath(__file__)) , "static","app","files")
#アップロード機能の動確完了!
やったぜ!
あー、また1ヵ月経っちまった...ちょうど1か月
いやぁ~、、これができた週の週末、燃え尽きた感じで、つぎになにするかが思いつかなかった...
Qiitaとかってこういう苦労の積み上げみたいなのが共有されるのがマジでIT以外にも広がってほしい。