https://github.com/ryancheley/pelican-to-sqlite
A plugin to take your published Pelican posts and put them into a SQLite database
https://github.com/ryancheley/pelican-to-sqlite
datasette oss pelican python sqlite
Last synced: 9 months ago
JSON representation
A plugin to take your published Pelican posts and put them into a SQLite database
- Host: GitHub
- URL: https://github.com/ryancheley/pelican-to-sqlite
- Owner: ryancheley
- License: apache-2.0
- Created: 2021-08-25T03:39:29.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T21:22:26.000Z (10 months ago)
- Last Synced: 2025-05-05T21:03:01.260Z (9 months ago)
- Topics: datasette, oss, pelican, python, sqlite
- Language: Python
- Homepage:
- Size: 85 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# pelican-to-sqlite
[](https://pypi.org/project/pelican-to-sqlite/)
[](https://github.com/ryancheley/pelican-to-sqlite/releases)
[](https://github.com/ryancheley/pelican-to-sqlite/actions?query=workflow%3ATest)
[](https://github.com/ryancheley/pelican-to-sqlite/blob/main/LICENSE)
[](https://results.pre-commit.ci/latest/github/ryancheley/pelican-to-sqlite/main)
Create a SQLite database containing data posts from your local [pelican](https://blog.getpelican.com) files.
## How to install
pip install pelican-to-sqlite
## Usage
Once the plugin has been installed you only need to run `make html` to create a SQLite database called `pelican.db` which will be created in the root of your pelican site.
You will need to add a form to your `base.html` template (or similar template depending on your theme). The form that needs to be added looks like this (assuming you use [Tailwind](https://tailwindcss.com)):
```
Search the site:
Search
```
In the above, `your-action-link-here` should be substituted for the link that you get from your Vercel hosted instance of `datasette`.
## Deploy using Vercel
There are many options to deploy your SQLite database with `datasette`. Below describes using Vercel.
First, install `datasette` using pip
```
pip install datasette
```
Next, install the datasette plugin `datasette-publish-vercel` using pip
```
pip install datasette-publish-vercel
```
and the [Vercel CLI](https://vercel.com/cli)
Once that's done, run `vercel login` to login to (or create) an account.
To publish your `pelican.db` to Vercel just run:
```
datasette publish vercel my-database.db
```
There are several options for outputting to Vercel. See the [documentation](https://github.com/simonw/datasette-publish-vercel/blob/main/README.md) for more details
## Using with Datasette
The SQLite database produced by this tool is designed to be browsed using [Datasette](https://datasette.readthedocs.io/). See my post [Adding Search to My Pelican Blog with Datasette](https://www.ryancheley.com/2022/01/16/adding-search-to-my-pelican-blog-with-datasette/) for more details on how I implemented it.