From fcc95deb057f821a5da19e40fa33a78c838c7f4b Mon Sep 17 00:00:00 2001 From: Test User Date: Sat, 7 Feb 2026 17:40:08 -0600 Subject: [PATCH] Add ultra-quickstart section to README and docs Adds a prominent ultra-quickstart section showing the fastest way to get started with Datasette using uv or pip: - README.md: New 'Ultra-quickstart' section right after intro - docs/getting_started.rst: Quickstart at the top - docs/installation.rst: Added 'uv' as recommended installation method Fixes #2625 --- README.md | 18 ++++++++++++++++++ docs/getting_started.rst | 10 ++++++++++ docs/installation.rst | 17 +++++++++++++++++ 3 files changed, 45 insertions(+) diff --git a/README.md b/README.md index 393e8e5c..976355b0 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,24 @@ Datasette is aimed at data journalists, museum curators, archivists, local gover [Explore a demo](https://datasette.io/global-power-plants/global-power-plants), watch [a video about the project](https://simonwillison.net/2021/Feb/7/video/) or try it out [on GitHub Codespaces](https://github.com/datasette/datasette-studio). +## Ultra-quickstart + +The fastest way to get started with Datasette if you have Python installed: + +```bash +# Install with uv (recommended) or pip +uv tool install datasette +# Or: pip install datasette + +# Serve a SQLite database +datasette my_database.db + +# Or try it with a demo database +datasette https://datasette.io/fixtures.db +``` + +Then visit http://localhost:8001 to explore your data. See [Getting started](https://docs.datasette.io/en/stable/getting_started.html) for more. + * [datasette.io](https://datasette.io/) is the official project website * Latest [Datasette News](https://datasette.io/news) * Comprehensive documentation: https://docs.datasette.io/ diff --git a/docs/getting_started.rst b/docs/getting_started.rst index ad917a3c..39572024 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -1,6 +1,16 @@ Getting started =============== +Ultra-quickstart +---------------- + +Just want to get going? If you have Python installed:: + + uv tool install datasette # or: pip install datasette + datasette my_database.db + +Then visit http://localhost:8001/ to explore your data. + .. _getting_started_demo: Play with a live demo diff --git a/docs/installation.rst b/docs/installation.rst index 33d3d6a1..2221e5fe 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -17,6 +17,23 @@ If you want to start making contributions to the Datasette project by installing Basic installation ================== +.. _installation_uv: + +Using uv (recommended) +---------------------- + +`uv `__ is a fast Python package installer and resolver. It's the quickest way to install Datasette:: + + uv tool install datasette + +You can then run Datasette with:: + + datasette --version + +To upgrade to the latest version:: + + uv tool upgrade datasette + .. _installation_datasette_desktop: Datasette Desktop for Mac