nbdevダウンロード - nbdevソースコードのダウンロード

nbdev

パイソン

v2.3.34

ダウンロード

はじめる

nbdev 、ノートブック駆動の開発プラットフォームです。軽量のマークアップを使用してノートブックを作成するだけで、高品質のドキュメント、テスト、継続的インテグレーション、パッケージ化を無料で入手できます。

nbdev使用すると、常にライブオブジェクトをすぐに利用できるため、コードのデバッグとリファクタリングが従来のプログラミング環境よりもはるかに簡単になります。 nbdevテストとドキュメントが第一級であるため、ソフトウェアエンジニアリングのベストプラクティスも推進しています。

ドキュメントはQuarto を使用して自動的に生成され、GitHub Pages でホストされます。ドキュメントは LaTeX をサポートし、検索可能で、自動的にハイパーリンクされます ( nbdev-indexを介した多くのパッケージのすぐに使用できるサポートを含む)
パッケージを PyPI と conda に公開するだけでなく、パッケージのリリースを簡素化するツールも公開します。 Python のベストプラクティスが自動的に適用されます。たとえば、エクスポートされたオブジェクトのみが__all__に含まれます。
ノートブックとプレーンテキストソースコード間の双方向同期により、コードナビゲーションやクイック編集に IDE を使用できるようになります。
通常のノートブックセルとして記述されたテストは、単一のコマンドで並列実行されます。
テストを実行してドキュメントを再構築する GitHub Actions を使用した、すぐに使用できる継続的統合
不要なメタデータをクリーンアップし、人間が読める形式でマージ競合をレンダリングする Jupyter/Git フックを備えたGit フレンドリーなノートブック
…などなど！

インストール

nbdev は、macOS、Linux、およびほとんどの Unix スタイルのオペレーティングシステムで動作します。 Windows では WSL では動作しますが、cmd または Powershell では動作しません。

pip を使用して nbdev をインストールできます。

pip install nbdev

…または conda (または mamba) を使用します。

conda install -c fastai nbdev

nbdev 、Jupyter とプロジェクトの両方で使用するのと同じ Python 環境にインストールする必要があることに注意してください。

nbdevの使い方

nbdev の使用方法を学ぶ最良の方法は、書面によるウォークスルーまたはビデオウォークスルーを完了することです。

あるいは、 unsilence Python ライブラリを使用してコーディングセクションを高速化したビデオウォークスルーの短縮バージョンもあります。これは 27 分速くなりますが、理解するのが少し難しくなります。

ターミナルからnbdev_helpを実行して、使用可能なコマンドの完全なリストを表示することもできます。

!n bdev_help

 nbdev_bump_version        Increment version in settings.ini by one
nbdev_changelog           Create a CHANGELOG.md file from closed and labeled GitHub issues
nbdev_clean               Clean all notebooks in `fname` to avoid merge conflicts
nbdev_conda               Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
nbdev_create_config       Create a config file.
nbdev_docs                Create Quarto docs and README.md
nbdev_export              Export notebooks in `path` to Python modules
nbdev_filter              A notebook filter for Quarto
nbdev_fix                 Create working notebook from conflicted notebook `nbname`
nbdev_help                Show help for all console scripts
nbdev_install             Install Quarto and the current library
nbdev_install_hooks       Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
nbdev_install_quarto      Install latest Quarto on macOS or Linux, prints instructions for Windows
nbdev_merge               Git merge driver for notebooks
nbdev_migrate             Convert all markdown and notebook files in `path` from v1 to v2
nbdev_new                 Create an nbdev project.
nbdev_prepare             Export, test, and clean notebooks, and render README if needed
nbdev_preview             Preview docs locally
nbdev_proc_nbs            Process notebooks in `path` for docs rendering
nbdev_pypi                Create and upload Python package to PyPI
nbdev_readme              Create README.md from readme_nb (index.ipynb by default)
nbdev_release_both        Release both conda and PyPI packages
nbdev_release_gh          Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
nbdev_release_git         Tag and create a release in GitHub for the current version
nbdev_requirements        Writes a `requirements.txt` file to `directory` based on settings.ini.
nbdev_sidebar             Create sidebar.yml
nbdev_test                Test in parallel notebooks matching `path`, passing along `flags`
nbdev_trust               Trust notebooks matching `fname`
nbdev_update              Propagate change in modules matching `fname` to notebooks that created them
nbdev_update_license      Allows you to update the license of your project.

よくある質問

Q: 「インポートと計算が混在するセルが見つかりました。」という警告は何ですか。別のセルを使用してください。」

A: エクスポートされていないセルや、 importステートメントと他のコードが混在するセルを含めることはできません。たとえば、これを単一のセルで実行しないでください。

 import some_module
some_module . something ()

代わりに、これを 2 つのセルに分割し、1 つはimport some_module実行し、もう 1 つはsome_module.something()を実行します。

その理由は、ドキュメント Web サイトを作成するときに、ノートブックでインポート、エクスポートされたセル、およびshow_doc関数を実行することによって、ドキュメント化された関数のすべての署名が最新であることを確認するためです。インポートを他のコードと混合すると、その他のコードも実行されるため、Web サイトの作成時にエラー (または少なくとも速度低下) が発生する可能性があります。

Q: nbdev が root アクセスを要求するのはなぜですか? root アクセス権なしで Quarto をインストールするにはどうすればよいですか?

A: 最初のプロジェクトをセットアップすると、nbdev は Quarto を自動的にダウンロードしてインストールしようとします。これは、ドキュメント Web サイトの作成に使用するプログラムです。

Quarto の標準インストールプロセスでは root アクセスが必要なため、nbdev はインストール中に root パスワードを要求します。ほとんどの人にとって、これは問題なく機能し、すべてが自動的に処理されます。その場合は、root アクセスを使用しないインストールについて説明するこのセクションの残りの部分をスキップしてください。

Linux に root アクセスなしで Quarto をインストールする必要がある場合は、まずcd保存したい場所に移動し、次に Quarto をダウンロードして、次のように入力します。

dpkg -x quarto * .deb .
mv opt/quarto ./
rmdir opt
mkdir -p ~ /.local/bin
ln -s " $( pwd ) " /quarto/bin/quarto ~ /.local/bin

この Quarto の非ルートバージョンを使用するには、 PATH環境変数に~/.local/bin必要です。 (あるいは、 ln -sステップを変更して、シンボリックリンクをパスの別の場所に配置します。)

Q: 「本格的な」ソフトウェア開発にはノートブックを使用しないようにと誰かが言いました。

A: このビデオを見てください。心配しないでください。過去 3 年間、ディープラーニングライブラリ、API クライアント、Python 言語拡張機能、ターミナルユーザーインターフェイスなどを含む幅広い「非常に本格的な」ソフトウェアプロジェクトにnbdev使用してきたにもかかわらず、私たちも同様の結果を得ることができました。！

貢献する

nbdevに貢献したい場合は、必ず貢献ガイドラインを確認してください。このプロジェクトは、fastai の行動規範に準拠しています。参加することにより、この規範を遵守することが期待されます。一般に、私たちはオープンソースソフトウェア開発において一般に受け入れられているベストプラクティスを遵守するよう努めています。

クローンされたリポジトリでnbdev_install_hooks実行して、 nbdevの git フックがインストールされていることを確認します。