14 | {% endif %}
15 |
16 |
43 |
44 | {% endblock %}
45 |
--------------------------------------------------------------------------------
/.github/workflows/publish.yml:
--------------------------------------------------------------------------------
1 | name: Publish Python Package
2 |
3 | on:
4 | release:
5 | types: [created]
6 |
7 | permissions:
8 | contents: read
9 |
10 | jobs:
11 | test:
12 | runs-on: ubuntu-latest
13 | strategy:
14 | matrix:
15 | python-version: ["3.7", "3.8", "3.9", "3.10"]
16 | steps:
17 | - uses: actions/checkout@v3
18 | - name: Set up Python ${{ matrix.python-version }}
19 | uses: actions/setup-python@v3
20 | with:
21 | python-version: ${{ matrix.python-version }}
22 | - name: Configure pip caching
23 | uses: actions/cache@v3
24 | with:
25 | path: ~/.cache/pip
26 | key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
27 | restore-keys: |
28 | ${{ runner.os }}-pip-
29 | - name: Install dependencies
30 | run: |
31 | pip install -e '.[test]'
32 | - name: Run tests
33 | run: |
34 | pytest
35 | deploy:
36 | runs-on: ubuntu-latest
37 | needs: [test]
38 | steps:
39 | - uses: actions/checkout@v3
40 | - name: Set up Python
41 | uses: actions/setup-python@v3
42 | with:
43 | python-version: "3.10"
44 | - uses: actions/cache@v3
45 | name: Configure pip caching
46 | with:
47 | path: ~/.cache/pip
48 | key: ${{ runner.os }}-publish-pip-${{ hashFiles('**/setup.py') }}
49 | restore-keys: |
50 | ${{ runner.os }}-publish-pip-
51 | - name: Install dependencies
52 | run: |
53 | pip install setuptools wheel twine build
54 | - name: Publish
55 | env:
56 | TWINE_USERNAME: __token__
57 | TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
58 | run: |
59 | python -m build
60 | twine upload dist/*
61 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # datasette-socrata
2 |
3 | [](https://pypi.org/project/datasette-socrata/)
4 | [](https://github.com/simonw/datasette-socrata/releases)
5 | [](https://github.com/simonw/datasette-socrata/actions?query=workflow%3ATest)
6 | [](https://github.com/simonw/datasette-socrata/blob/main/LICENSE)
7 |
8 | Import data from [Socrata](https://dev.socrata.com/) into [Datasette](https://datasette.io/)
9 |
10 | ## Installation
11 |
12 | Install this plugin in the same environment as Datasette.
13 |
14 | datasette install datasette-socrata
15 |
16 | ## Usage
17 |
18 | Make sure you have [enabled WAL mode](https://til.simonwillison.net/sqlite/enabling-wal-mode) on your database files before using this plugin.
19 |
20 | Once installed, an interface for importing data from Socrata will become available at this URL:
21 |
22 | /-/import-socrata
23 |
24 | Users will be able to paste in a URL to a dataset on Socrata in order to initialize an import.
25 |
26 | You can also pre-fill the form by passing a `?url=` parameter, for example:
27 |
28 | /-/import-socrata?url=https://data.sfgov.org/City-Infrastructure/Street-Tree-List/tkzw-k3nq
29 |
30 | Any database that is attached to Datasette, is NOT loaded as immutable (with the `-i` option) and that has WAL mode enabled will be available for users to import data into.
31 |
32 | The `import-socrata` permission governs access. By default the `root` actor (accessible using `datasette --root` to start Datasette) is granted that permission.
33 |
34 | You can use permission plugins such as [datasette-permissions-sql](https://github.com/simonw/datasette-permissions-sql) to grant additional access to other users.
35 |
36 | ## Configuration
37 |
38 | If you only want Socrata imports to be allowed to a specific database, you can configure that using plugin configration in `metadata.yml`:
39 |
40 | ```yaml
41 | plugins:
42 | datasette-socrata:
43 | database: socrata
44 | ```
45 |
46 | ## Development
47 |
48 | To set up this plugin locally, first checkout the code. Then create a new virtual environment:
49 |
50 | cd datasette-socrata
51 | python3 -m venv venv
52 | source venv/bin/activate
53 |
54 | Now install the dependencies and test dependencies:
55 |
56 | pip install -e '.[test]'
57 |
58 | To run the tests:
59 |
60 | pytest
61 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/tests/test_socrata.py:
--------------------------------------------------------------------------------
1 | from datasette.app import Datasette
2 | from datasette import hookimpl
3 | from datasette.plugins import pm
4 | import sqlite_utils
5 | from sqlite_utils.utils import maximize_csv_field_size_limit
6 | import csv
7 | import pytest
8 | import httpx
9 | import asyncio
10 |
11 |
12 | @pytest.fixture
13 | def non_mocked_hosts():
14 | return ["localhost"]
15 |
16 |
17 | @pytest.fixture
18 | def datasette(tmpdir):
19 | db_path = str(tmpdir / "data.db")
20 | sqlite_utils.Database(db_path).enable_wal()
21 | return Datasette([db_path])
22 |
23 |
24 | @pytest.fixture
25 | def datasette2(tmpdir):
26 | # Datasette with two attached WAL databases, and one not-WAL
27 | db_paths = []
28 | for name in ("data2.db", "data3.db", "notwal.db"):
29 | db_path = str(tmpdir / name)
30 | if name == "notwal.db":
31 | sqlite_utils.Database(db_path).vacuum()
32 | else:
33 | sqlite_utils.Database(db_path).enable_wal()
34 | db_paths.append(db_path)
35 | return Datasette(db_paths)
36 |
37 |
38 | def mock_metadata_and_count(httpx_mock):
39 | httpx_mock.add_response(
40 | url="https://data.edmonton.ca/api/views/24uj-dj8v.json",
41 | json={
42 | "id": "24uj-dj8v",
43 | "name": "General Building Permits",
44 | "description": "List of issued building permits from the City of Edmonton",
45 | "license": {
46 | "name": "Example license",
47 | "termsLink": "http://www.example.com/",
48 | },
49 | "columns": [
50 | {
51 | "name": "id",
52 | "description": "The ID",
53 | },
54 | {
55 | "name": "species",
56 | "description": "What species",
57 | },
58 | ],
59 | },
60 | )
61 | httpx_mock.add_response(
62 | url="https://data.edmonton.ca/resource/24uj-dj8v.json?$select=count(*)",
63 | json=[{"count": "2"}],
64 | )
65 |
66 |
67 | @pytest.mark.asyncio
68 | async def test_import_shows_preview(datasette, httpx_mock):
69 | mock_metadata_and_count(httpx_mock)
70 | response = await datasette.client.get(
71 | "/-/import-socrata",
72 | params={
73 | "url": "https://data.edmonton.ca/Urban-Planning-Economy/General-Building-Permits/24uj-dj8v"
74 | },
75 | cookies={"ds_actor": datasette.sign({"a": {"id": "root"}}, "actor")},
76 | )
77 | assert response.status_code == 200
78 | request = httpx_mock.get_requests()[0]
79 | assert request.url == "https://data.edmonton.ca/api/views/24uj-dj8v.json"
80 | html = response.text
81 | assert '
' not in html
82 | assert "
General Building Permits - 2 rows
" in html
83 | assert ">List of issued building permits from the City of Edmonton<" in html
84 | assert (
85 | "