id,node_id,name,full_name,private,owner,html_url,description,fork,created_at,updated_at,pushed_at,homepage,size,stargazers_count,watchers_count,language,has_issues,has_projects,has_downloads,has_wiki,has_pages,forks_count,archived,disabled,open_issues_count,license,topics,forks,open_issues,watchers,default_branch,permissions,temp_clone_token,organization,network_count,subscribers_count,readme,readme_html,allow_forking,visibility,is_template,template_repository,web_commit_signoff_required,has_discussions
242260583,MDEwOlJlcG9zaXRvcnkyNDIyNjA1ODM=,datasette-mask-columns,simonw/datasette-mask-columns,0,9599,https://github.com/simonw/datasette-mask-columns,Datasette plugin that masks specified database columns,0,2020-02-22T01:29:16Z,2021-06-10T19:50:37Z,2021-06-10T19:51:02Z,https://datasette.io/plugins/datasette-mask-columns,15,2,2,Python,1,1,1,1,0,0,0,0,0,apache-2.0,"[""datasette"", ""datasette-plugin"", ""datasette-io""]",0,0,2,main,"{""admin"": false, ""push"": false, ""pull"": false}",,,0,1,"# datasette-mask-columns

[![PyPI](https://img.shields.io/pypi/v/datasette-mask-columns.svg)](https://pypi.org/project/datasette-mask-columns/)
[![Changelog](https://img.shields.io/github/v/release/simonw/datasette-mask-columns?include_prereleases&label=changelog)](https://github.com/simonw/datasette-mask-columns/releases)
[![Tests](https://github.com/simonw/datasette-mask-columns/workflows/Test/badge.svg)](https://github.com/simonw/datasette-mask-columns/actions?query=workflow%3ATest)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-mask-columns/blob/main/LICENSE)

Datasette plugin that masks specified database columns

## Installation

    pip install datasette-mask-columns

This depends on plugin hook changes in a not-yet released branch of Datasette. See [issue #678](https://github.com/simonw/datasette/issues/678) for details.

## Usage

In your `metadata.json` file add a section like this describing the database and table in which you wish to mask columns:

```json
{
    ""databases"": {
        ""my-database"": {
            ""plugins"": {
                ""datasette-mask-columns"": {
                    ""users"": [""password""]
                }
            }
        }
    }
}
```
All SQL queries against the `users` table in `my-database.db` will now return `null` for the `password` column, no matter what value that column actually holds.

The table page for `users` will display the text `REDACTED` in the masked column. This visual hint will only be available on the table page; it will not display his text for arbitrary queries against the table.
","<div id=""readme"" class=""md"" data-path=""README.md""><article class=""markdown-body entry-content container-lg"" itemprop=""text""><h1><a id=""user-content-datasette-mask-columns"" class=""anchor"" aria-hidden=""true"" href=""#user-content-datasette-mask-columns""><svg class=""octicon octicon-link"" viewBox=""0 0 16 16"" version=""1.1"" width=""16"" height=""16"" aria-hidden=""true""><path fill-rule=""evenodd"" d=""M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z""></path></svg></a>datasette-mask-columns</h1>
<p><a href=""https://pypi.org/project/datasette-mask-columns/"" rel=""nofollow""><img src=""https://camo.githubusercontent.com/09772a46d884b67ea26bd94868ec94be4bd514fa0a4a8ea3fac1b707801e4d3d/68747470733a2f2f696d672e736869656c64732e696f2f707970692f762f6461746173657474652d6d61736b2d636f6c756d6e732e737667"" alt=""PyPI"" data-canonical-src=""https://img.shields.io/pypi/v/datasette-mask-columns.svg"" style=""max-width:100%;""></a>
<a href=""https://github.com/simonw/datasette-mask-columns/releases""><img src=""https://camo.githubusercontent.com/f3fb962acca8cb0fd0c0caeb303007c6c199287a95f5b2f9bfb2128bec3b1dc3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f73696d6f6e772f6461746173657474652d6d61736b2d636f6c756d6e733f696e636c7564655f70726572656c6561736573266c6162656c3d6368616e67656c6f67"" alt=""Changelog"" data-canonical-src=""https://img.shields.io/github/v/release/simonw/datasette-mask-columns?include_prereleases&amp;label=changelog"" style=""max-width:100%;""></a>
<a href=""https://github.com/simonw/datasette-mask-columns/actions?query=workflow%3ATest""><img src=""https://github.com/simonw/datasette-mask-columns/workflows/Test/badge.svg"" alt=""Tests"" style=""max-width:100%;""></a>
<a href=""https://github.com/simonw/datasette-mask-columns/blob/main/LICENSE""><img src=""https://camo.githubusercontent.com/1698104e976c681143eb0841f9675c6f802bb7aa832afc0c7a4e719b1f3cf955/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d417061636865253230322e302d626c75652e737667"" alt=""License"" data-canonical-src=""https://img.shields.io/badge/license-Apache%202.0-blue.svg"" style=""max-width:100%;""></a></p>
<p>Datasette plugin that masks specified database columns</p>
<h2><a id=""user-content-installation"" class=""anchor"" aria-hidden=""true"" href=""#user-content-installation""><svg class=""octicon octicon-link"" viewBox=""0 0 16 16"" version=""1.1"" width=""16"" height=""16"" aria-hidden=""true""><path fill-rule=""evenodd"" d=""M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z""></path></svg></a>Installation</h2>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""pip install datasette-mask-columns
""><pre><code>pip install datasette-mask-columns
</code></pre></div>
<p>This depends on plugin hook changes in a not-yet released branch of Datasette. See <a href=""https://github.com/simonw/datasette/issues/678"">issue #678</a> for details.</p>
<h2><a id=""user-content-usage"" class=""anchor"" aria-hidden=""true"" href=""#user-content-usage""><svg class=""octicon octicon-link"" viewBox=""0 0 16 16"" version=""1.1"" width=""16"" height=""16"" aria-hidden=""true""><path fill-rule=""evenodd"" d=""M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z""></path></svg></a>Usage</h2>
<p>In your <code>metadata.json</code> file add a section like this describing the database and table in which you wish to mask columns:</p>
<div class=""highlight highlight-source-json position-relative"" data-snippet-clipboard-copy-content=""{
    &quot;databases&quot;: {
        &quot;my-database&quot;: {
            &quot;plugins&quot;: {
                &quot;datasette-mask-columns&quot;: {
                    &quot;users&quot;: [&quot;password&quot;]
                }
            }
        }
    }
}
""><pre>{
    <span class=""pl-s""><span class=""pl-pds"">""</span>databases<span class=""pl-pds"">""</span></span>: {
        <span class=""pl-s""><span class=""pl-pds"">""</span>my-database<span class=""pl-pds"">""</span></span>: {
            <span class=""pl-s""><span class=""pl-pds"">""</span>plugins<span class=""pl-pds"">""</span></span>: {
                <span class=""pl-s""><span class=""pl-pds"">""</span>datasette-mask-columns<span class=""pl-pds"">""</span></span>: {
                    <span class=""pl-s""><span class=""pl-pds"">""</span>users<span class=""pl-pds"">""</span></span>: [<span class=""pl-s""><span class=""pl-pds"">""</span>password<span class=""pl-pds"">""</span></span>]
                }
            }
        }
    }
}</pre></div>
<p>All SQL queries against the <code>users</code> table in <code>my-database.db</code> will now return <code>null</code> for the <code>password</code> column, no matter what value that column actually holds.</p>
<p>The table page for <code>users</code> will display the text <code>REDACTED</code> in the masked column. This visual hint will only be available on the table page; it will not display his text for arbitrary queries against the table.</p>
</article></div>",,,,,,
346597557,MDEwOlJlcG9zaXRvcnkzNDY1OTc1NTc=,tableau-to-sqlite,simonw/tableau-to-sqlite,0,9599,https://github.com/simonw/tableau-to-sqlite,Fetch data from Tableau into a SQLite database,0,2021-03-11T06:12:02Z,2021-06-10T04:40:44Z,2021-04-29T16:11:03Z,,212,8,8,Python,1,1,1,1,0,2,0,0,2,apache-2.0,"[""datasette-io"", ""datasette-tool""]",2,2,8,main,"{""admin"": false, ""push"": false, ""pull"": false}",,,2,1,"# tableau-to-sqlite

[![PyPI](https://img.shields.io/pypi/v/tableau-to-sqlite.svg)](https://pypi.org/project/tableau-to-sqlite/)
[![Changelog](https://img.shields.io/github/v/release/simonw/tableau-to-sqlite?include_prereleases&label=changelog)](https://github.com/simonw/tableau-to-sqlite/releases)
[![Tests](https://github.com/simonw/tableau-to-sqlite/workflows/Test/badge.svg)](https://github.com/simonw/tableau-to-sqlite/actions?query=workflow%3ATest)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/tableau-to-sqlite/blob/master/LICENSE)

Fetch data from Tableau into a SQLite database. A wrapper around [TableauScraper](https://github.com/bertrandmartel/tableau-scraping/).

## Installation

Install this tool using `pip`:

    $ pip install tableau-to-sqlite

## Usage

If you have the URL to a Tableau dashboard like this:

https://results.mo.gov/t/COVID19/views/VaccinationsDashboard/Vaccinations

You can pass that directly to the tool:

    tableau-to-sqlite tableau.db \
      https://results.mo.gov/t/COVID19/views/VaccinationsDashboard/Vaccinations

This will create a SQLite database called `tableau.db` containing one table for each of the worksheets in that dashboard.

If the dashboard is hosted on https://public.tableau.com/ you can instead provide the view name. This will be two strings separated by a `/` symbol - something like this:

    OregonCOVID-19VaccineProviderEnrollment/COVID-19VaccineProviderEnrollment

Now run the tool like this:

    tableau-to-sqlite tableau.db \
        OregonCOVID-19VaccineProviderEnrollment/COVID-19VaccineProviderEnrollment

## Get the data as JSON or CSV

If you're building a [git scraper](https://simonwillison.net/2020/Oct/9/git-scraping/) you may want to convert the data gathered by this tool to CSV or JSON to check into your repository.

You can do that using [sqlite-utils](https://sqlite-utils.datasette.io/). Install it using `pip`:

    pip install sqlite-utils

You can dump out a table as JSON like so:

    sqlite-utils rows tableau.db \
       'Admin Site and County Map Site No Info' > tableau.json

Or as CSV like this:

    sqlite-utils rows tableau.db --csv \
       'Admin Site and County Map Site No Info' > tableau.csv

## Development

To contribute to this tool, first checkout the code. Then create a new virtual environment:

    cd tableau-to-sqlite
    python -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
","<div id=""readme"" class=""md"" data-path=""README.md""><article class=""markdown-body entry-content container-lg"" itemprop=""text""><h1><a id=""user-content-tableau-to-sqlite"" class=""anchor"" aria-hidden=""true"" href=""#user-content-tableau-to-sqlite""><svg class=""octicon octicon-link"" viewBox=""0 0 16 16"" version=""1.1"" width=""16"" height=""16"" aria-hidden=""true""><path fill-rule=""evenodd"" d=""M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z""></path></svg></a>tableau-to-sqlite</h1>
<p><a href=""https://pypi.org/project/tableau-to-sqlite/"" rel=""nofollow""><img src=""https://camo.githubusercontent.com/bdda6efc6980f655c99f0475b322f27bbc413e7e13e847e55e697dd135d10601/68747470733a2f2f696d672e736869656c64732e696f2f707970692f762f7461626c6561752d746f2d73716c6974652e737667"" alt=""PyPI"" data-canonical-src=""https://img.shields.io/pypi/v/tableau-to-sqlite.svg"" style=""max-width:100%;""></a>
<a href=""https://github.com/simonw/tableau-to-sqlite/releases""><img src=""https://camo.githubusercontent.com/fd18da3a8541734c627a9be68134477abe876a8695165916ff7c8c5bbf7269eb/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f73696d6f6e772f7461626c6561752d746f2d73716c6974653f696e636c7564655f70726572656c6561736573266c6162656c3d6368616e67656c6f67"" alt=""Changelog"" data-canonical-src=""https://img.shields.io/github/v/release/simonw/tableau-to-sqlite?include_prereleases&amp;label=changelog"" style=""max-width:100%;""></a>
<a href=""https://github.com/simonw/tableau-to-sqlite/actions?query=workflow%3ATest""><img src=""https://github.com/simonw/tableau-to-sqlite/workflows/Test/badge.svg"" alt=""Tests"" style=""max-width:100%;""></a>
<a href=""https://github.com/simonw/tableau-to-sqlite/blob/master/LICENSE""><img src=""https://camo.githubusercontent.com/1698104e976c681143eb0841f9675c6f802bb7aa832afc0c7a4e719b1f3cf955/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d417061636865253230322e302d626c75652e737667"" alt=""License"" data-canonical-src=""https://img.shields.io/badge/license-Apache%202.0-blue.svg"" style=""max-width:100%;""></a></p>
<p>Fetch data from Tableau into a SQLite database. A wrapper around <a href=""https://github.com/bertrandmartel/tableau-scraping/"">TableauScraper</a>.</p>
<h2><a id=""user-content-installation"" class=""anchor"" aria-hidden=""true"" href=""#user-content-installation""><svg class=""octicon octicon-link"" viewBox=""0 0 16 16"" version=""1.1"" width=""16"" height=""16"" aria-hidden=""true""><path fill-rule=""evenodd"" d=""M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z""></path></svg></a>Installation</h2>
<p>Install this tool using <code>pip</code>:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""$ pip install tableau-to-sqlite
""><pre><code>$ pip install tableau-to-sqlite
</code></pre></div>
<h2><a id=""user-content-usage"" class=""anchor"" aria-hidden=""true"" href=""#user-content-usage""><svg class=""octicon octicon-link"" viewBox=""0 0 16 16"" version=""1.1"" width=""16"" height=""16"" aria-hidden=""true""><path fill-rule=""evenodd"" d=""M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z""></path></svg></a>Usage</h2>
<p>If you have the URL to a Tableau dashboard like this:</p>
<p><a href=""https://results.mo.gov/t/COVID19/views/VaccinationsDashboard/Vaccinations"" rel=""nofollow"">https://results.mo.gov/t/COVID19/views/VaccinationsDashboard/Vaccinations</a></p>
<p>You can pass that directly to the tool:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""tableau-to-sqlite tableau.db \
  https://results.mo.gov/t/COVID19/views/VaccinationsDashboard/Vaccinations
""><pre><code>tableau-to-sqlite tableau.db \
  https://results.mo.gov/t/COVID19/views/VaccinationsDashboard/Vaccinations
</code></pre></div>
<p>This will create a SQLite database called <code>tableau.db</code> containing one table for each of the worksheets in that dashboard.</p>
<p>If the dashboard is hosted on <a href=""https://public.tableau.com/"" rel=""nofollow"">https://public.tableau.com/</a> you can instead provide the view name. This will be two strings separated by a <code>/</code> symbol - something like this:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""OregonCOVID-19VaccineProviderEnrollment/COVID-19VaccineProviderEnrollment
""><pre><code>OregonCOVID-19VaccineProviderEnrollment/COVID-19VaccineProviderEnrollment
</code></pre></div>
<p>Now run the tool like this:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""tableau-to-sqlite tableau.db \
    OregonCOVID-19VaccineProviderEnrollment/COVID-19VaccineProviderEnrollment
""><pre><code>tableau-to-sqlite tableau.db \
    OregonCOVID-19VaccineProviderEnrollment/COVID-19VaccineProviderEnrollment
</code></pre></div>
<h2><a id=""user-content-get-the-data-as-json-or-csv"" class=""anchor"" aria-hidden=""true"" href=""#user-content-get-the-data-as-json-or-csv""><svg class=""octicon octicon-link"" viewBox=""0 0 16 16"" version=""1.1"" width=""16"" height=""16"" aria-hidden=""true""><path fill-rule=""evenodd"" d=""M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z""></path></svg></a>Get the data as JSON or CSV</h2>
<p>If you're building a <a href=""https://simonwillison.net/2020/Oct/9/git-scraping/"" rel=""nofollow"">git scraper</a> you may want to convert the data gathered by this tool to CSV or JSON to check into your repository.</p>
<p>You can do that using <a href=""https://sqlite-utils.datasette.io/"" rel=""nofollow"">sqlite-utils</a>. Install it using <code>pip</code>:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""pip install sqlite-utils
""><pre><code>pip install sqlite-utils
</code></pre></div>
<p>You can dump out a table as JSON like so:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""sqlite-utils rows tableau.db \
   'Admin Site and County Map Site No Info' &gt; tableau.json
""><pre><code>sqlite-utils rows tableau.db \
   'Admin Site and County Map Site No Info' &gt; tableau.json
</code></pre></div>
<p>Or as CSV like this:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""sqlite-utils rows tableau.db --csv \
   'Admin Site and County Map Site No Info' &gt; tableau.csv
""><pre><code>sqlite-utils rows tableau.db --csv \
   'Admin Site and County Map Site No Info' &gt; tableau.csv
</code></pre></div>
<h2><a id=""user-content-development"" class=""anchor"" aria-hidden=""true"" href=""#user-content-development""><svg class=""octicon octicon-link"" viewBox=""0 0 16 16"" version=""1.1"" width=""16"" height=""16"" aria-hidden=""true""><path fill-rule=""evenodd"" d=""M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z""></path></svg></a>Development</h2>
<p>To contribute to this tool, first checkout the code. Then create a new virtual environment:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""cd tableau-to-sqlite
python -mvenv venv
source venv/bin/activate
""><pre><code>cd tableau-to-sqlite
python -mvenv venv
source venv/bin/activate
</code></pre></div>
<p>Or if you are using <code>pipenv</code>:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""pipenv shell
""><pre><code>pipenv shell
</code></pre></div>
<p>Now install the dependencies and tests:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""pip install -e '.[test]'
""><pre><code>pip install -e '.[test]'
</code></pre></div>
<p>To run the tests:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""pytest
""><pre><code>pytest
</code></pre></div>
</article></div>",,,,,,
375546675,MDEwOlJlcG9zaXRvcnkzNzU1NDY2NzU=,datasette-placekey,simonw/datasette-placekey,0,9599,https://github.com/simonw/datasette-placekey,SQL functions for working with placekeys,0,2021-06-10T02:31:27Z,2021-06-10T02:33:22Z,2021-06-10T02:32:42Z,https://datasette.io/plugins/datasette-placekey,3,0,0,Python,1,1,1,1,0,0,0,0,1,,"[""datasette"", ""datasette-plugin"", ""datasette-io"", ""placekey""]",0,1,0,main,"{""admin"": false, ""push"": false, ""pull"": false}",,,0,1,"# datasette-placekey

[![PyPI](https://img.shields.io/pypi/v/datasette-placekey.svg)](https://pypi.org/project/datasette-placekey/)
[![Changelog](https://img.shields.io/github/v/release/simonw/datasette-placekey?include_prereleases&label=changelog)](https://github.com/simonw/datasette-placekey/releases)
[![Tests](https://github.com/simonw/datasette-placekey/workflows/Test/badge.svg)](https://github.com/simonw/datasette-placekey/actions?query=workflow%3ATest)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-placekey/blob/main/LICENSE)

SQL functions for working with [placekeys](https://www.placekey.io/).

## Installation

Install this plugin in the same environment as Datasette.

    $ datasette install datasette-placekey

## Usage

The following SQL functions are exposed - [documentation here](https://placekey.github.io/placekey-py/placekey.html#module-placekey.placekey).

```sql
select
  geo_to_placekey(33.0896104,129.7900839),
  placekey_to_geo('@6nh-nhh-kvf'),
  placekey_to_geo_latitude('@6nh-nhh-kvf'),
  placekey_to_geo_longitude('@6nh-nhh-kvf'),
  placekey_to_h3('@6nh-nhh-kvf'),
  h3_to_placekey('8a30d94e4c87fff'),
  placekey_to_geojson('@6nh-nhh-kvf'),
  placekey_to_wkt('@6nh-nhh-kvf'),
  placekey_format_is_valid('@6nh-nhh-kvf');
```

## Development

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

    cd datasette-placekey
    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
","<div id=""readme"" class=""md"" data-path=""README.md""><article class=""markdown-body entry-content container-lg"" itemprop=""text""><h1><a id=""user-content-datasette-placekey"" class=""anchor"" aria-hidden=""true"" href=""#user-content-datasette-placekey""><svg class=""octicon octicon-link"" viewBox=""0 0 16 16"" version=""1.1"" width=""16"" height=""16"" aria-hidden=""true""><path fill-rule=""evenodd"" d=""M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z""></path></svg></a>datasette-placekey</h1>
<p><a href=""https://pypi.org/project/datasette-placekey/"" rel=""nofollow""><img src=""https://camo.githubusercontent.com/a570339480e04ec2eedd623479156b479b30fafcd8fa2ff60250a22ee4e77ed2/68747470733a2f2f696d672e736869656c64732e696f2f707970692f762f6461746173657474652d706c6163656b65792e737667"" alt=""PyPI"" data-canonical-src=""https://img.shields.io/pypi/v/datasette-placekey.svg"" style=""max-width:100%;""></a>
<a href=""https://github.com/simonw/datasette-placekey/releases""><img src=""https://camo.githubusercontent.com/120db4c1d380188526a62cbe06a80176d5be627da0b962b724e32422291df31c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f73696d6f6e772f6461746173657474652d706c6163656b65793f696e636c7564655f70726572656c6561736573266c6162656c3d6368616e67656c6f67"" alt=""Changelog"" data-canonical-src=""https://img.shields.io/github/v/release/simonw/datasette-placekey?include_prereleases&amp;label=changelog"" style=""max-width:100%;""></a>
<a href=""https://github.com/simonw/datasette-placekey/actions?query=workflow%3ATest""><img src=""https://github.com/simonw/datasette-placekey/workflows/Test/badge.svg"" alt=""Tests"" style=""max-width:100%;""></a>
<a href=""https://github.com/simonw/datasette-placekey/blob/main/LICENSE""><img src=""https://camo.githubusercontent.com/1698104e976c681143eb0841f9675c6f802bb7aa832afc0c7a4e719b1f3cf955/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d417061636865253230322e302d626c75652e737667"" alt=""License"" data-canonical-src=""https://img.shields.io/badge/license-Apache%202.0-blue.svg"" style=""max-width:100%;""></a></p>
<p>SQL functions for working with <a href=""https://www.placekey.io/"" rel=""nofollow"">placekeys</a>.</p>
<h2><a id=""user-content-installation"" class=""anchor"" aria-hidden=""true"" href=""#user-content-installation""><svg class=""octicon octicon-link"" viewBox=""0 0 16 16"" version=""1.1"" width=""16"" height=""16"" aria-hidden=""true""><path fill-rule=""evenodd"" d=""M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z""></path></svg></a>Installation</h2>
<p>Install this plugin in the same environment as Datasette.</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""$ datasette install datasette-placekey
""><pre><code>$ datasette install datasette-placekey
</code></pre></div>
<h2><a id=""user-content-usage"" class=""anchor"" aria-hidden=""true"" href=""#user-content-usage""><svg class=""octicon octicon-link"" viewBox=""0 0 16 16"" version=""1.1"" width=""16"" height=""16"" aria-hidden=""true""><path fill-rule=""evenodd"" d=""M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z""></path></svg></a>Usage</h2>
<p>The following SQL functions are exposed - <a href=""https://placekey.github.io/placekey-py/placekey.html#module-placekey.placekey"" rel=""nofollow"">documentation here</a>.</p>
<div class=""highlight highlight-source-sql position-relative"" data-snippet-clipboard-copy-content=""select
  geo_to_placekey(33.0896104,129.7900839),
  placekey_to_geo('@6nh-nhh-kvf'),
  placekey_to_geo_latitude('@6nh-nhh-kvf'),
  placekey_to_geo_longitude('@6nh-nhh-kvf'),
  placekey_to_h3('@6nh-nhh-kvf'),
  h3_to_placekey('8a30d94e4c87fff'),
  placekey_to_geojson('@6nh-nhh-kvf'),
  placekey_to_wkt('@6nh-nhh-kvf'),
  placekey_format_is_valid('@6nh-nhh-kvf');
""><pre><span class=""pl-k"">select</span>
  geo_to_placekey(<span class=""pl-c1"">33</span>.<span class=""pl-c1"">0896104</span>,<span class=""pl-c1"">129</span>.<span class=""pl-c1"">7900839</span>),
  placekey_to_geo(<span class=""pl-s""><span class=""pl-pds"">'</span>@6nh-nhh-kvf<span class=""pl-pds"">'</span></span>),
  placekey_to_geo_latitude(<span class=""pl-s""><span class=""pl-pds"">'</span>@6nh-nhh-kvf<span class=""pl-pds"">'</span></span>),
  placekey_to_geo_longitude(<span class=""pl-s""><span class=""pl-pds"">'</span>@6nh-nhh-kvf<span class=""pl-pds"">'</span></span>),
  placekey_to_h3(<span class=""pl-s""><span class=""pl-pds"">'</span>@6nh-nhh-kvf<span class=""pl-pds"">'</span></span>),
  h3_to_placekey(<span class=""pl-s""><span class=""pl-pds"">'</span>8a30d94e4c87fff<span class=""pl-pds"">'</span></span>),
  placekey_to_geojson(<span class=""pl-s""><span class=""pl-pds"">'</span>@6nh-nhh-kvf<span class=""pl-pds"">'</span></span>),
  placekey_to_wkt(<span class=""pl-s""><span class=""pl-pds"">'</span>@6nh-nhh-kvf<span class=""pl-pds"">'</span></span>),
  placekey_format_is_valid(<span class=""pl-s""><span class=""pl-pds"">'</span>@6nh-nhh-kvf<span class=""pl-pds"">'</span></span>);</pre></div>
<h2><a id=""user-content-development"" class=""anchor"" aria-hidden=""true"" href=""#user-content-development""><svg class=""octicon octicon-link"" viewBox=""0 0 16 16"" version=""1.1"" width=""16"" height=""16"" aria-hidden=""true""><path fill-rule=""evenodd"" d=""M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z""></path></svg></a>Development</h2>
<p>To set up this plugin locally, first checkout the code. Then create a new virtual environment:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""cd datasette-placekey
python3 -mvenv venv
source venv/bin/activate
""><pre><code>cd datasette-placekey
python3 -mvenv venv
source venv/bin/activate
</code></pre></div>
<p>Or if you are using <code>pipenv</code>:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""pipenv shell
""><pre><code>pipenv shell
</code></pre></div>
<p>Now install the dependencies and tests:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""pip install -e '.[test]'
""><pre><code>pip install -e '.[test]'
</code></pre></div>
<p>To run the tests:</p>
<div class=""snippet-clipboard-content position-relative"" data-snippet-clipboard-copy-content=""pytest
""><pre><code>pytest
</code></pre></div>
</article></div>",,,,,,