Toolverse
Wszystkie skille

datasette-plugin-writer

autor: simonw

Twórz wtyczki do Datasette – przewodnik po hookach, szablonach i konfiguracji

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Autor
simonw
Kategoria
Data Science

O skillu

Umiejętność dla programistów, którzy chcą rozszerzać Datasette – narzędzie do eksploracji i publikacji danych. Dowiedz się, jak pisać wtyczki od podstaw: konfiguruj hooki, obsługuj żądania HTTP, pracuj z bazami danych SQLite i używaj szablonów. Zawiera gotowy szablon cookiecutter, strukturę projektu, przykłady kodu i wskazówki do testowania.

Jak używać

  1. Zainstaluj wtyczkę za pomocą cookiecutter, przygotowując dane: nazwę wtyczki (np. "my cool plugin"), krótki opis, nazwę z myślnikami (np. "my-cool-plugin"), nazwę ze znakami podkreślenia, nazwę użytkownika GitHub i swoje imię. Uruchom polecenie echo z danymi przekierowanymi do cookiecutter, które utworzy katalog projektu.

  2. Przejdź do katalogu projektu i skonfiguruj środowisko: utwórz wirtualne środowisko Pythona, aktywuj je, zainstaluj zależności razem z narzędziami testowymi poleceniem pip install -e '.[test]'.

  3. Zweryfikuj, że wtyczka jest widoczna w systemie, uruchamiając datasette plugins – powinna pojawić się na liście zainstalowanych wtyczek.

  4. Otwórz plik init.py w katalogu wtyczki i zdefiniuj hooki, które chcesz użyć: prepare_connection do rejestrowania funkcji SQL, register_routes do dodawania nowych ścieżek URL, lub inne hooki zgodnie z dokumentacją Datasette.

  5. Dodaj statyczne pliki (CSS, JavaScript) w katalogu static/ i szablony HTML w katalogu templates/, jeśli twoja wtyczka ich wymaga.

  6. Uruchom testy poleceniem python -m pytest, aby upewnić się, że wtyczka działa poprawnie, a następnie opublikuj projekt na GitHubie lub PyPI.

Podobne skille