Datasette plugin for publishing data using Vercel
Project description
datasette-publish-vercel
Datasette plugin for publishing data using Vercel.
Installation
Install this plugin in the same environment as Datasette.
$ pip install datasette-publish-vercel
Usage
First, install the Vercel CLI tool by following their instructions.
Run vercel login
to login to (or create) an account.
Now you can use datasette publish vercel
to publish your data:
datasette publish vercel my-database.db --project=my-database
The --project
argument is required - it specifies the project name that should be used for your deployment. This will be used as part of the deployment's URL.
Other options
--no-prod
deploys to the project without updating the "production" URL alias to point to that new deployment. Without that option all deploys go directly to production.--debug
enables the Vercel CLI debug output--token
allows you to pass a Now authentication token, rather than needing to first runnow login
to configure the tool--public
runsvercel --public
to publish the application source code at/_src
e.g. https://datasette-public.now.sh/_src and make recent logs visible at/_logs
e.g. https://datasette-public.now.sh/_logs--generate-dir
- by default this tool generates a new Vercel app in a temporary directory, deploys it and then deletes the directory. Use--generate-dir=my-app
to output the generated application files to a new directory of your choice instead. You can then deploy it by runningvercel
in that directory.
Full help
Warning: Some of these options are not yet implemented by this plugin. In particular, the following do not yet work:
--extra-options
--plugin-secret
--version-note
$ datasette publish vercel --help
Usage: datasette publish vercel [OPTIONS] [FILES]...
Publish to https://vercel.com/
Options:
-m, --metadata FILENAME Path to JSON/YAML file containing metadata to publish
--extra-options TEXT Extra options to pass to datasette serve
--branch TEXT Install datasette from a GitHub branch e.g. master
--template-dir DIRECTORY Path to directory containing custom templates
--plugins-dir DIRECTORY Path to directory containing custom plugins
--static MOUNT:DIRECTORY Serve static files from this directory at /MOUNT/...
--install TEXT Additional packages (e.g. plugins) to install
--plugin-secret <TEXT TEXT TEXT>...
Secrets to pass to plugins, e.g. --plugin-secret
datasette-auth-github client_id xxx
--version-note TEXT Additional note to show on /-/versions
--secret TEXT Secret used for signing secure values, such as signed
cookies
--title TEXT Title for metadata
--license TEXT License label for metadata
--license_url TEXT License URL for metadata
--source TEXT Source label for metadata
--source_url TEXT Source URL for metadata
--about TEXT About label for metadata
--about_url TEXT About URL for metadata
--token TEXT Auth token to use for deploy
--project PROJECT Vercel project name to use [required]
--no-prod Don't deploy directly to production
--debug Enable Vercel CLI debug output
--public Publish source with Vercel CLI --public
--generate-dir DIRECTORY Output generated application files here
--help Show this message and exit.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for datasette_publish_vercel-0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcd17ed43df526c799cea7e4da500ca8d6ddc8dce0ef019465bf920bc34a8700 |
|
MD5 | f59f446a7b195d7d59befd793b4f0afb |
|
BLAKE2b-256 | db57809692904816b403253ad27aa9b518d5b12fac33b32d9a27abf1d6fda52b |