https://github.com/postman-open-technologies/datasette-gfm

Datasette plugin for exporting data as GitHub flavoured markdown tables
https://github.com/postman-open-technologies/datasette-gfm

datasette datasette-plugin gfm markdown tables

Last synced: about 1 month ago
JSON representation

Datasette plugin for exporting data as GitHub flavoured markdown tables

• Host: GitHub
• URL: https://github.com/postman-open-technologies/datasette-gfm
• Owner: postman-open-technologies
• Created: 2021-05-13T01:31:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-05-17T15:46:43.000Z (over 3 years ago)
• Last Synced: 2024-12-06T21:25:42.173Z (about 1 month ago)
• Topics: datasette, datasette-plugin, gfm, markdown, tables
• Language: Python
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# datasette-gfm

[![PyPI](https://img.shields.io/pypi/v/datasette-gfm.svg)](https://pypi.org/project/datasette-gfm/)

[![Changelog](https://img.shields.io/github/v/release/postman-open-technologies/datasette-gfm?include_prereleases&label=changelog)](https://github.com/postman-open-technologies/datasette-gfm/releases)

[![Tests](https://github.com/postman-open-technologies/datasette-gfm/workflows/Test/badge.svg)](https://github.com/postman-open-technologies/datasette-gfm/actions?query=workflow%3ATest)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/postman-open-technologies/datasette-gfm/blob/main/LICENSE)

Export Datasette records as GitHub flavoured markdown

## Installation

Install this plugin in the same environment as Datasette.

    $ datasette install datasette-gfm

## Usage

Having installed this plugin, every table and query will gain a new `.md` export link.

You can also construct these URLs directly: `/dbname/tablename.md`

## Demo

TBD

## Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

    cd datasette-gfm

    python3 -mvenv venv

    source venv/bin/activate

Or if you are using `pipenv`:

    pipenv shell

Now install the dependencies and tests:

    pip install -e '.[test]'

To run the tests:

    pytest

## Thanks

This plugin is very heavily based on [datasette-yaml](https://github.com/simonw/datasette-yaml) by Simon Willison.