Jupyter Book-bővítmény létrehozása

Ez az oktatóanyag bemutatja, hogyan hozhat létre új Jupyter Book Azure Data Studio-bővítményt. A bővítmény egy jupyter-mintakönyvet szállít, amely megnyitható és futtatható az Azure Data Studióban.

Ebben a cikkben az alábbiakkal fog megismerkedni:

• Bővítményprojekt létrehozása.
• Telepítse a bővítménygenerátort.
• Hozza létre a Jupyter Book bővítményt.
• Futtassa a bővítményt.
• Csomagolja be a bővítményt.
• Tegye közzé a bővítményt a piactéren.

Használt API-k

• bookTreeView.openBook

Bővítményhasználati esetek

Több különböző oka is van annak, hogy miért hozna létre Jupyter Book-bővítményt:

• Szervezett és szakaszolt interaktív dokumentáció megosztása
• Teljes könyv megosztása (hasonló egy e-könyvhöz, de az Azure Data Studióban terjesztve)
• A Jupyter Book frissítéseinek verziója és nyomon követése

A Jupyter Book és a notebook bővítmények közötti fő különbség az, hogy a Jupyter Book biztosítja a szervezetet. Több tíz jegyzetfüzetet fel lehet osztani a Jupyter Book különböző fejezeteibe, de a jegyzetfüzet-bővítmény kis számú különálló jegyzetfüzet szállítására szolgál.

Előfeltételek

Az Azure Data Studio ugyanarra a keretrendszerre épül, mint a Visual Studio Code, így az Azure Data Studio bővítményei a Visual Studio Code használatával készülnek. Első lépésként a következő összetevőkre van szüksége:

• Node.js telepítve és elérhető a $PATH. Node.js tartalmazza az npm-et, a Node.js Csomagkezelő, amelyet a bővítménygenerátor telepítéséhez használnak.
• A Visual Studio Code a bővítmény módosításainak elvégzéséhez és a bővítmény hibakereséséhez.
• Győződjön meg arról azuredatastudio , hogy az elérési úton van. Windows esetén győződjön meg arról, hogy a Hozzáadás az elérési úthoz lehetőséget választja a setup.exe. Mac vagy Linux esetén futtassa az "azuredatastudio" parancsot a PATH-ban az Azure Data Studio parancskatalógusából.

A bővítménygenerátor telepítése

A bővítmények létrehozásának egyszerűsítése érdekében létrehoztunk egy bővítménygenerátort a Yeoman használatával. A telepítéshez futtassa a következő parancsot a parancssorból:

npm install -g yo generator-azuredatastudio

A bővítmény létrehozása

Bővítmény létrehozása:

1. Indítsa el a bővítménygenerátort a következő paranccsal:

   yo azuredatastudio

2. Válassza a New Jupyter Book (Új Jupyter Book ) elemet a bővítménytípusok listájából.

   

3. A bővítmény nevének kitöltéséhez kövesse az alábbi lépéseket. Ebben az oktatóanyagban használja a Tesztkönyvet. Ezután adja meg a közzétevő nevét. Ebben az oktatóanyagban használja a Microsoftot. Végül adjon hozzá egy leírást.

Választhatja, hogy egy meglévő Jupyter-könyvet ad meg, egy megadott mintakönyvet használ, vagy új Jupyter-könyvet hoz létre. Mindhárom lehetőség megjelenik.

Meglévő könyv megadása

Ha már létrehozott könyvet szeretne szállítani, adja meg annak a mappának az abszolút elérési útját, amelyben a könyv tartalma található. Ezután továbbléphet a bővítmény megismerésére és szállítására.

A mintakönyv használata

Ha nem rendelkezik meglévő könyvekkel vagy jegyzetfüzetekkel, használhatja a megadott mintát a generátorban.

A mintakönyv bemutatja, hogyan néz ki egy egyszerű Jupyter Book. Ha szeretné megtudni, hogyan szabhat testre egy Jupyter-könyvet, tekintse meg az alábbi szakaszt arról, hogyan hozhat létre új könyvet meglévő jegyzetfüzetekkel.

Új könyv létrehozása

Ha olyan jegyzetfüzetei vannak, amelyeket jupyter-könyvbe szeretne csomagolni, megteheti. A generátor megkérdezi, hogy szeretne-e fejezeteket a könyvében, és ha igen, hányat és a címüket. Itt láthatja, hogyan néz ki a kijelölési folyamat. A szóközzel kiválaszthatja, hogy mely jegyzetfüzeteket szeretné elhelyezni az egyes fejezetekben.

Az előző lépések elvégzése új mappát hoz létre az új Jupyter Book-tal. Nyissa meg a mappát a Visual Studio Code-ban, és készen áll a Jupyter Book-bővítmény szállítására.

A bővítmény ismertetése

A projektnek jelenleg így kell kinéznie:

A vsc-extension-quickstart.md fájl a fontos fájlokra mutató hivatkozást tartalmaz. Itt README.md adhat meg dokumentációt az új bővítményhez. Jegyezze fel a package.json, jupyter-book.ts, contentés toc.yml a fájlokat. A content mappa tartalmazza az összes jegyzetfüzet- vagy Markdown-fájlt. A toc.yml struktúrák a Jupyter Book, és automatikusan létre, ha úgy döntött, hogy hozzon létre egy egyéni Jupyter Book keresztül a bővítmény generátor.

Ha a generátor használatával létrehozott egy könyvet, és a könyv fejezeteit választotta, a mappaszerkezet egy kicsit másképp nézne ki. A mappában content élő Markdown- és Jupyter Notebook-fájlok helyett léteznek almappák, amelyek megfelelnek a fejezetekhez választott címeknek.

Ha vannak olyan fájlok vagy mappák, amelyeket nem szeretne közzétenni, felveheti a nevüket a .vscodeignore fájlba.

Vessünk egy pillantást jupyter-book.ts , hogy megértsük, mit csinál az újonnan létrehozott bővítmény.

// This function is called when you run the command `Launch Book: Test Book` from the
// command palette in Azure Data Studio. If you want any additional functionality
// to occur when you launch the book, add it to the activate function.
export function activate(context: vscode.ExtensionContext) {
    context.subscriptions.push(vscode.commands.registerCommand('launchBook.test-book', () => {
        processNotebooks();
    }));

    // Add other code here if you want to register another command.
}

A activate függvény a bővítmény fő művelete. A regisztrálni kívánt parancsok a parancshoz launchBook.test-book hasonlóan a függvényen belül activate jelennek meg. A függvényen belül megtaláljuk a processNotebooks Jupyter Bookot tartalmazó bővítménymappát, és paraméterként a bővítmény mappáját használva hívjuk meg bookTreeView.openBook .

A package.json fájl fontos szerepet játszik a bővítmény parancsának regisztrálásában is.

"activationEvents": [
		"onCommand:launchBook.test-book"
	],
	"main": "./out/notebook.js",
	"contributes": {
		"commands": [
			{
				"command": "launchBook.test-book",
				"title": "Launch Book: Test Book"
			}
		]
	}

Az aktiválási esemény onCommandaktiválja a parancs meghívásakor regisztrált függvényt. Van néhány egyéb aktiválási esemény, amelyek további testreszabásra is alkalmasak. További információ: Aktiválási események.

A bővítmény csomagolása

A másokkal való megosztáshoz a bővítményt egyetlen fájlba kell csomagolnia. A bővítmény közzétehető az Azure Data Studio bővítmények piacterén, vagy megoszthatja a csapatával vagy a közösségével. Ehhez a lépéshez telepítenie kell egy másik npm-csomagot a parancssorból.

npm install -g vsce

Szerkessze a README.md fájlt tetszés szerint. Ezután lépjen a bővítmény alapkönyvtárára, és futtassa a parancsot vsce package. Az adattárakat csatolhatja a bővítményhez, vagy anélkül folytathatja. Ha hozzá szeretne adni egyet, adjon hozzá egy hasonló sort a package.json fájlhoz.

"repository": {
    "type": "git",
    "url": "https://github.com/laurajjiang/testbook.git"
}

A sorok hozzáadása után létrejön egy my test-book-0.0.1.vsix fájl, és készen áll a telepítésre az Azure Data Studióban.

A bővítmény futtatása

A bővítmény futtatásához és teszteléséhez nyissa meg az Azure Data Studiót, és nyissa meg a parancspalettát a Ctrl+Shift+P billentyűkombinációval. Keresse meg a bővítmények parancsot : Telepítse a VSIX-ből, és lépjen az új bővítményt tartalmazó mappára. Ekkor megjelenik a bővítménypanelen az Azure Data Studióban.

Nyissa meg ismét a parancskatalógust, és keresse meg a regisztrált parancsot: Könyv indítása: Tesztjegyzetfüzet. Futáskor meg kell nyitnia a Jupyter Book-t, amelyet a bővítményünkkel csomagoltunk.

Gratulálunk! Elkészítette és most már szállíthatja az első Jupyter Book-bővítményt. További információ a Jupyter Booksról: Könyvek a Jupyterrel.

Bővítmény közzététele a Marketplace-en

Az Azure Data Studio bővítmény piactere már fejlesztés alatt áll. A közzétételhez tárolja a VSIX bővítményt valahol, például egy GitHub-kiadási lapon. Küldjön be egy lekéréses kérelmet, amely frissíti ezt a JSON-fájlt a bővítmény adataival.

Következő lépések

Ez az oktatóanyag bemutatta, hogyan végezheti el az alábbi műveleteket:

• Bővítményprojekt létrehozása.
• Telepítse a bővítménygenerátort.
• Hozza létre a Jupyter Book bővítményt.
• Csomagolja be a bővítményt.
• Tegye közzé a bővítményt a piactéren.

Reméljük, hogy a cikk elolvasása után ötleteket talál a Jupyter Booksról, amelyeket meg szeretne osztani az Azure Data Studio közösségével.

Ha van egy ötlete, de nem tudja, hogyan kezdjen hozzá, nyisson meg egy problémát, vagy tweetelje a csapatot az azuredatastudio webhelyen.

További információkért a Visual Studio Code bővítmény útmutatója az összes meglévő API-t és mintát ismerteti.