Text files
authorJavier Sancho <jsf@jsancho.org>
Thu, 4 Oct 2018 11:50:25 +0000 (13:50 +0200)
committerJavier Sancho <jsf@jsancho.org>
Thu, 4 Oct 2018 11:50:25 +0000 (13:50 +0200)
ANNOUNCE.md [new file with mode: 0644]
DEVELOPERS.md [new file with mode: 0644]
LICENSE [new file with mode: 0644]
MANIFEST.in [new file with mode: 0644]
README.md [new file with mode: 0644]
RELEASE_NOTES.md [new file with mode: 0644]
RELEASING.md [new file with mode: 0644]

diff --git a/ANNOUNCE.md b/ANNOUNCE.md
new file mode 100644 (file)
index 0000000..26fd1b6
--- /dev/null
@@ -0,0 +1,18 @@
+# Announcing datasette-connectors 0.25
+
+## What's new
+
+This is the first release of datasette-connectors, derived from the [Datasette](https://github.com/simonw/datasette) fork for supporting [Datasette-Pytables](https://github.com/PyTables/datasette-pytables).
+
+## What it is
+
+[Datasette](https://github.com/simonw/datasette) is a Python module which provides a web interface and a JSON API for SQLite files. But, in conjuntion with Datasette-Connectors, it can accept external connectors for any kind of database files, so you can develop your own connector for your favourite data container if you want (read [developers doc](https://github.com/PyTables/datasette-connectors/blob/master/DEVELOPERS.md)).
+
+## Resources
+
+Visit the main datasette-connectors site repository at:
+https://github.com/PyTables/datasette-connectors
+
+----
+
+  **Enjoy data!**
diff --git a/DEVELOPERS.md b/DEVELOPERS.md
new file mode 100644 (file)
index 0000000..c93ec41
--- /dev/null
@@ -0,0 +1,65 @@
+# How to make connectors for other data sources?
+
+With Datasette-Connectors you can use [Datasette](https://github.com/simonw/datasette) for publishing data in your own format, not only SQLite, to the Internet with a JSON API. For this, you have to make connectors using the interface that is described here.
+
+## Tables inspection
+
+First of all, you need to implement a special method called `inspect` that receives the path of the file as an argument and returns a tuple formed by a dictionary with tables info, a list with views name and a string identifying the connector. Each entry in the dictionary for tables info has the next structure:
+
+    tables['table_name'] = {
+        'name': 'table_name',
+        'columns': ['c1', 'c2'],
+        'primary_keys': [],
+        'count': 100,
+        'label_column': None,
+        'hidden': False,
+        'fts_table': None,
+        'foreign_keys': {'incoming': [], 'outgoing': []}
+
+This structure is used in [Datasette-PyTables](https://github.com/PyTables/datasette-pytables). In your case, you may need additional entries like primary keys or foreign keys.
+
+## Returning results
+
+Datasette uses SQL for specifying the queries, so your connector has to accept SQL and execute it. The next class and methods are needed:
+
+    class Connection:
+        def __init__(self, path):
+            ...
+
+        def execute(self, sql, params=None, truncate=False, page_size=None, max_returned_rows=None):
+            ...
+
+The `Connection.execute()` method receives:
+
+* **sql**: the query
+* **params**: a dictionary with the params used in the query
+* **truncate**: a boolean saying if the returned data can be separated in pages or not
+* **page_size**: the number of rows a page can contain
+* **max_returned_rows**: the maximum number of rows Datasette expects
+
+Probably, you'll need to parse the SQL query if your data container has its own style for queries, but other databases could work with the SQL queries without requiring any parsing.
+
+Note: Sometimes, Datasette make queries to `sqlite_master`; you need to keep it in mind.
+
+The `Connection.execute()` method has to return a tuple with:
+
+* a list of rows (Datasette expects something similar to SQLite rows)
+* a boolean saying if the data is truncated, i.e., if we return all the rows or there are more rows than the maximum indicated in max_returned_rows
+* a tuple with the description of the columns in the form `(('c1',), ('c2',), ...)`
+
+## Rows format
+
+Datasette receives the results from the queries with SQLite row instances, so you need to return your rows in a similar way.
+
+For example, if you have the next query:
+
+    SELECT name FROM persons
+
+you need to return an object that allows to do things like:
+
+    row[0] == 'Susan'
+    row['name'] == 'Susan'
+    [c for c in row] == ['Susan']
+    json.dumps(row)
+
+For example, you can extend the `list` object to get it, but as long as you implement a similar interface, you can develop your own implementation too.
diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..1ccbeea
--- /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 {2018} {PyTables developers}
+
+   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/MANIFEST.in b/MANIFEST.in
new file mode 100644 (file)
index 0000000..a17c59a
--- /dev/null
@@ -0,0 +1,2 @@
+include README.md
+include VERSION
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..bdfc0b8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# datasette-connectors
+
+[Datasette](https://github.com/simonw/datasette) is a Python module which provides a web interface and a JSON API for SQLite files. But, in conjuntion with Datasette-Connectors, it can accept external connectors for any kind of database files, so you can develop your own connector for your favourite data container if you want (read [developers doc](https://github.com/PyTables/datasette-connectors/blob/master/DEVELOPERS.md)).
+
+## Installation
+
+Run `pip install datasette-connectors` to install both Datasette and Datasette-Connectors. Easy as pie!
+
+## Usage
+
+You can use Datasette from the console in the traditional way:
+
+    datasette serve path/to/data.h5
+
+This will start a web server on port 8001; then you can access to your data visiting [http://localhost:8001/](http://localhost:8001/)
+
+Or you can use Datasette in your own Python programs:
+
+    from datasette_connectors import monkey; monkey.patch_datasette()
+    from datasette_connectors import connectors; connectors.load()
+
+For that, you need to patch the original Datasette and load the external connectors.
+
+Read the [Datasette documentation](http://datasette.readthedocs.io/en/latest/) for more advanced options.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
new file mode 100644 (file)
index 0000000..8afbfb0
--- /dev/null
@@ -0,0 +1,8 @@
+# Release notes for datasette-connectors
+
+
+## Initial version 0.25
+
+* Compatible with Datasette 0.25
+
+* Basic API for external connectors.
diff --git a/RELEASING.md b/RELEASING.md
new file mode 100644 (file)
index 0000000..6cb7b52
--- /dev/null
@@ -0,0 +1,119 @@
+# Releasing datasette-connectors
+
+Author: Javier Sancho, Francesc Alted
+Contact: jsf@jsancho.org, francesc@blosc.org
+Date: 2018-10-04
+
+
+## Preliminaries
+
+* Update the version number at ``VERSION`` and ``ANNOUNCE.md``.
+
+* Make sure that ``RELEASE_NOTES.md`` and ``ANNOUNCE.md`` are up to
+  date with the latest news in the release.
+
+* Commit your changes:
+
+```
+    $ git commit -a -m"Getting ready for X.Y.Z final"
+```
+
+* Once a year: check that the copyright year in `LICENSE` file.
+
+
+## Tagging
+
+* Create a tag ``vX.Y.Z`` from ``master``.  Use the next message:
+
+```
+    $ git tag -a vX.Y.Z -m "Tagging version X.Y.Z"
+```
+
+  Note: For release candidates, just add a rcN suffix to tag ("vX.Y.ZrcN").
+
+* Or, alternatively, make a signed tag (requires gpg correctly configured):
+
+```
+    $ git tag -s vX.Y.Z -m "Tagging version X.Y.Z"
+```
+
+* Push the tag to the Github repo:
+
+```
+    $ git push
+    $ git push --tags
+```
+
+* Do the official release.  Go to:
+
+https://github.com/PyTables/datasette-connectors/releases/edit/vX.Y.Z
+
+and add the title for the release (vX.Y.Z) and the release notes there.
+
+
+## Testing
+
+* Go to the root directory and run:
+
+```
+    $ pytest
+```
+
+
+## Packaging
+
+* Make sure that you are in a clean directory.  The best way is to
+  re-clone and re-build:
+
+```
+  $ cd /tmp
+  $ git clone https://github.com/PyTables/datasette-connectors
+  $ cd datasette-connectors
+  $ python setup.py build
+  $ pytest
+```
+
+* Make the tarball with the command:
+
+```
+  $ python setup.py sdist
+```
+
+Do a quick check that the tarball is sane.
+
+
+## Uploading
+
+* Upload it also in the PyPi repository:
+
+```
+    $ python setup.py sdist upload
+```
+
+
+## Announcing
+
+* Send an announcement to the pytables-announce, pytables-users and pydata
+  lists.  Use the ``ANNOUNCE.md`` file as skeleton (or possibly as
+  the definitive version).
+
+* Tweet about the new release and rejoice!
+
+
+## Post-release actions
+
+* Create new headers for adding new features in ``RELEASE_NOTES.rst``
+  and add this place-holder instead:
+
+  #XXX version-specific blurb XXX#
+
+* Update ``VERSION`` file to X.Y.(Z+1)-dev
+
+* Commit your changes with:
+
+```
+  $ git commit -a -m"Post X.Y.Z release actions done"
+```
+
+
+That's all folks!