diff --git a/.travis.yml b/.travis.yml index d739efb..200d19f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -30,8 +30,8 @@ jobs: - provider: pypi user: simonw distributions: bdist_wheel - password: - secure: ikY6iF+/2AxFlwcun35iAEz7Wbrnp0Fp7b32Z7uob5RsGpIDCYYDa3T/qNhiyNsg5fecGp01rBf1F+dL357b0rWEeaoONtsDrTKFeBUB6bMnzNtr3QbHq/TeQ1f+Vn6FWpY9360Ihbz0pKPzWWYHJxOjXPM793rGWmPu7siCc4oQZOpwLK28GZeFP803wq/QG81hFRWR8IiMlqljkecEGhaM6ftxzizk1LBoTZCw3DdL2xDwzrLvF3Hg1jXX08pJm9WrLJNS6i+LRhiLv9IJ5KxRDwNHJhrvblRrZn0CKVbiWR/8985r4R7CXaeG68uJ505RcVoXYRsq9D7mAcYAB3U5AzU9TsPQlvUgwJlFpKOsZlCw+5AHFIYUXvlP2Qo5kfXUYC9KKdJwbWjcW7isUqWpzInGfnmRNMJGzmIm2q65ua0FNLV4vK1wl98O60HFSyhXJi84YmCAPgidJ22sEA6sHAdMEFiWglhap12zPc6i7trXKC8aLjW/3qGXhUq3BK8vQcbutGer+Q3z9UM7kthB76FtCUVc8eqljtdAcGt5kXoHIEPwGb50ikOxo/qpXsXVH36Z6plbELbayXb3ocUrMdhWP5+kfnrdLEmx+X4IpUauxGUqLGliYSQpfjp8XyA87ASCjsSqUEjr/4t4YztW5a3mWBYZ+IjjYXW6PQg= + password: ${PYPI_PASSWORD} on: branch: master tags: true + repo: simonw/datasette-vega diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 616aeef..b634a87 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # datasette-vega +[![PyPI](https://img.shields.io/pypi/v/datasette-vega.svg)](https://pypi.org/project/datasette-vega/) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-vega/blob/master/LICENSE) + A [Datasette](https://github.com/simonw/datasette) plugin that provides tools for generating charts using [Vega](https://vega.github.io/). @@ -17,5 +20,3 @@ If you are publishing data using the `datasette publish` command, you can include this plugin like so: datasette publish now mydatabase.db --install=datasette-vega - -If you don't want to install any software at all, you can publish your CSV files with Datasette and activate this plugin using the web application at https://publish.datasettes.com/ diff --git a/datasette_vega/__init__.py b/datasette_vega/__init__.py index ea03f63..ac80b52 100644 --- a/datasette_vega/__init__.py +++ b/datasette_vega/__init__.py @@ -1,11 +1,28 @@ from datasette import hookimpl +import glob +import os + +cache = {} +static_dir = os.path.join(os.path.dirname(__file__), "static") + + +def cached_filepaths_for_extension(extension): + pattern = os.path.join(static_dir, "*.{}".format(extension)) + if pattern not in cache: + cache[pattern] = [ + "/-/static-plugins/datasette_vega/{}".format(os.path.basename(g)) + for g in glob.glob(pattern) + ] + return cache[pattern] @hookimpl -def extra_css_urls(): - return ["/-/static-plugins/datasette_vega/datasette-vega.css"] +def extra_css_urls(view_name): + if view_name == "table": + return cached_filepaths_for_extension("css") @hookimpl -def extra_js_urls(): - return ["/-/static-plugins/datasette_vega/datasette-vega.js"] +def extra_js_urls(view_name): + if view_name == "table": + return cached_filepaths_for_extension("js") diff --git a/package.json b/package.json index fdab351..969c2a2 100644 --- a/package.json +++ b/package.json @@ -3,17 +3,28 @@ "version": "0.1.0", "private": true, "dependencies": { - "react": "^16.4.1", - "react-dom": "^16.4.1", - "react-scripts": "1.1.4", - "source-map-explorer": "^1.5.0", - "vega-embed": "^3.15.0", - "vega-lib": "^4.0.0-rc.3" + "react": "^17.0.2", + "react-dom": "^17.0.2", + "react-scripts": "^4.0.3", + "vega-embed": "^6.20.5", + "vega-lib": "^4.4.0" }, "scripts": { "start": "REACT_APP_STAGE=dev react-scripts start", "build": "react-scripts build", "test": "react-scripts test --env=jsdom", "eject": "react-scripts eject" + }, + "browserslist": { + "production": [ + ">0.2%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 1 chrome version", + "last 1 firefox version", + "last 1 safari version" + ] } } diff --git a/public/index.html b/public/index.html index 0b14e70..2df60a7 100644 --- a/public/index.html +++ b/public/index.html @@ -7,7 +7,7 @@ Datasette Vega - +

Datasette Vega

Enter the URL of the JSON version of any Datasette table:

diff --git a/setup.py b/setup.py index faed859..8dc8722 100644 --- a/setup.py +++ b/setup.py @@ -4,20 +4,21 @@ from subprocess import check_output from wheel.bdist_wheel import bdist_wheel import os -VERSION = '0.5' +VERSION = "0.7a0" ROOT = os.path.dirname(os.path.abspath(__file__)) def get_long_description(): - with open(os.path.join( - os.path.dirname(os.path.abspath(__file__)), 'README.md' - ), encoding='utf8') as fp: + with open( + os.path.join(os.path.dirname(os.path.abspath(__file__)), "README.md"), + encoding="utf8", + ) as fp: return fp.read() class BdistWheelWithBuildStatic(bdist_wheel): def run(self): - self.run_command('build_static') + self.run_command("build_static") return bdist_wheel.run(self) @@ -31,37 +32,41 @@ class BuildStatic(Command): pass def run(self): - check_output(['npm', 'install'], cwd=ROOT) - check_output(['npm', 'run', 'build'], cwd=ROOT) - check_output(['mkdir', '-p', 'datasette_vega/static'], cwd=ROOT) - check_output("mv build/static/js/*.js datasette_vega/static/datasette-vega.js", shell=True, cwd=ROOT) - check_output("mv build/static/css/*.css datasette_vega/static/datasette-vega.css", shell=True, cwd=ROOT) + check_output(["npm", "install"], cwd=ROOT) + check_output(["npm", "run", "build"], cwd=ROOT) + check_output(["mkdir", "-p", "datasette_vega/static"], cwd=ROOT) + check_output( + "mv build/static/js/* datasette_vega/static/", shell=True, cwd=ROOT + ) + check_output( + "mv build/static/css/* datasette_vega/static/", shell=True, cwd=ROOT + ) setup( - name='datasette-vega', - description='A Datasette plugin that provides tools for generating charts using Vega', + name="datasette-vega", + description="A Datasette plugin that provides tools for generating charts using Vega", long_description=get_long_description(), - long_description_content_type='text/markdown', - author='Simon Willison', - url='https://github.com/simonw/datasette-vega', - license='Apache License, Version 2.0', + long_description_content_type="text/markdown", + author="Simon Willison", + url="https://github.com/simonw/datasette-vega", + license="Apache License, Version 2.0", version=VERSION, - packages=['datasette_vega'], + packages=["datasette_vega"], entry_points={ - 'datasette': [ - 'vega = datasette_vega' - ], + "datasette": ["vega = datasette_vega"], }, package_data={ - 'datasette_vega': [ - 'static/datasette-vega.js', - 'static/datasette-vega.css', + "datasette_vega": [ + "static/*.js", + "static/*.css", + "static/*.map", ], }, cmdclass={ - 'bdist_wheel': BdistWheelWithBuildStatic, - 'build_static': BuildStatic, + "bdist_wheel": BdistWheelWithBuildStatic, + "build_static": BuildStatic, }, - install_requires=['datasette'] + install_requires=["datasette"], + extras_require={"test": ["pytest", "pytest-asyncio", "httpx"]}, ) diff --git a/src/DatasetteVega.js b/src/DatasetteVega.js index b2cf979..b617a01 100644 --- a/src/DatasetteVega.js +++ b/src/DatasetteVega.js @@ -21,6 +21,8 @@ const unserialize = (s, prefix) => { return obj; }; +const escapeString = s => (s || '').replace(/"/g, '\\x22').replace(/'/g, '\\x27'); + class DatasetteVega extends Component { state = { show: false, @@ -33,6 +35,10 @@ class DatasetteVega extends Component { color_column: "", size_column: "" } + constructor(props) { + super(props); + this.chartRef = React.createRef(); + } markOptions = [ {"value": "bar", "name": "Bar"}, {"value": "line", "name": "Line"}, @@ -132,7 +138,8 @@ class DatasetteVega extends Component { const y_bin = !!/-bin$/.exec(this.state.y_type); let encoding = { x: {field: this.state.x_column, type: x_type, bin: x_bin}, - y: {field: this.state.y_column, type: y_type, bin: y_bin} + y: {field: this.state.y_column, type: y_type, bin: y_bin}, + tooltip: {field: "_tooltip_summary", type: "ordinal"}, } if (this.state.color_column) { encoding.color = {field: this.state.color_column, type: "nominal"}; @@ -144,11 +151,20 @@ class DatasetteVega extends Component { data: { url: this.jsonUrl() }, + transform: [{ + calculate: ` + '${escapeString(this.state.x_column)}: ' + datum['${escapeString(this.state.x_column)}'] + + ', ${escapeString(this.state.y_column)}: ' + datum['${escapeString(this.state.y_column)}'] + + (${!!this.state.color_column} ? ', ${escapeString(this.state.color_column)}: ' + datum['${escapeString(this.state.color_column)}'] : '') + + (${!!this.state.size_column} ? ', ${escapeString(this.state.size_column)}: ' + datum['${escapeString(this.state.size_column)}'] : '') + `, + as: "_tooltip_summary" + }], mark: this.state.mark, encoding: encoding } if (spec.mark && spec.encoding.x.field && spec.encoding.y.field) { - vegaEmbed(this.chart, spec, {theme: 'quartz', tooltip: true}); + vegaEmbed(this.chartRef.current, spec, {theme: 'quartz', tooltip: true}); document.location.hash = '#' + this.serializeState(); this.props.onFragmentChange && this.props.onFragmentChange(); // Add to state so react debug tools can see it (for debugging): @@ -220,7 +236,7 @@ class DatasetteVega extends Component {
-
{ this.chart = c; }}>
+
: null ); diff --git a/src/index.css b/src/index.css index cbabe2a..983aee4 100644 --- a/src/index.css +++ b/src/index.css @@ -1,14 +1,14 @@ -body { +body.datasette-vega-demo { margin: 0; padding: 1em; font-family: sans-serif; } -form div { +body.datasette-vega-demo form div { margin-bottom: 0.5em } -label { +body.datasette-vega-demo label { padding-right: 0.5em; } diff --git a/tests/test_vega.py b/tests/test_vega.py new file mode 100644 index 0000000..a77cd7f --- /dev/null +++ b/tests/test_vega.py @@ -0,0 +1,11 @@ +import pytest +from datasette.app import Datasette + + +@pytest.mark.asyncio +async def test_plugin_is_installed(): + ds = Datasette([], memory=True) + response = await ds.client.get("/-/plugins.json") + assert response.status_code == 200 + installed_plugins = {p["name"] for p in response.json()} + assert "datasette-vega" in installed_plugins