queryapigate 0.6.0__tar.gz → 0.7.0__tar.gz

queryapigate-0.7.0/LICENSE

@@ -0,0 +1,110 @@
+# Functional Source License, Version 1.1, MIT Future License
+
+## Abbreviation
+
+FSL-1.1-MIT
+
+## Notice
+
+Copyright 2024-2026 Anantha Raju C
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the MIT license that is effective on the second anniversary of the date we make
+the Software available. On or after that date, you may use the Software under
+the MIT license, in which case the following will apply:
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{queryapigate-0.6.0/queryapigate.egg-info → queryapigate-0.7.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: queryapigate
-Version: 0.6.0
+Version: 0.7.0
 Summary: Turn SQL into a REST API: run queries against MySQL, PostgreSQL, ClickHouse, SQLite or H2 over HTTP and get JSON, CSV, XML, YAML or XLSX back.
 Author-email: Anantha Raju C <arcswdev@gmail.com>
-License-Expression: MIT
+License-Expression: FSL-1.1-MIT
 Project-URL: Homepage, https://github.com/AnanthaRajuC/QueryAPIGate
 Project-URL: Documentation, https://AnanthaRajuC.github.io/QueryAPIGate/
 Project-URL: Repository, https://github.com/AnanthaRajuC/QueryAPIGate
@@ -64,7 +64,7 @@ Dynamic: license-file
 [![codecov](https://codecov.io/gh/AnanthaRajuC/QueryAPIGate/branch/main/graph/badge.svg)](https://codecov.io/gh/AnanthaRajuC/QueryAPIGate)
 [![PyPI](https://img.shields.io/pypi/v/queryapigate.svg)](https://pypi.org/project/queryapigate/)
 [![PyPI downloads](https://img.shields.io/pypi/dm/queryapigate.svg)](https://pypi.org/project/queryapigate/)
-[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE)
+[![License: FSL-1.1-MIT](https://img.shields.io/badge/license-FSL--1.1--MIT-blue.svg)](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE)
 ![Python](https://img.shields.io/badge/python-3.9%2B-blue)
 
 ### Turn SQL queries into secure, governed REST APIs.
@@ -81,13 +81,13 @@ serialization boilerplate for it.
 Write SQL. Configure the query. Apply access controls. Get an API.
 
 ~~~bash
-$ curl 'http://127.0.0.1:5000/q/actor_by_id?id=7'
-[{"actor_id": 7, "first_name": "GRACE", "last_name": "MOSTEL"}]
+$ curl 'http://127.0.0.1:5000/q/example_film_search?text=Harbor&page_size=2'
+[{"film_id":48,"title":"Broken Harbor","category":"Action","rating":"PG-13"},{"film_id":44,"title":"Electric Harbor","category":"Documentary","rating":"G"}]
 
-$ curl 'http://127.0.0.1:5000/q/films_by_rating?rating=PG&max_length=60&format=csv&page_size=2'
-film_id,title,rating,length
-410,HEAVEN FREEDOM,PG,48
-443,HURRICANE AFFAIR,PG,49
+$ curl 'http://127.0.0.1:5000/q/example_top_films?top_n=2&category=Comedy&format=csv'
+title,category,rating,rentals,rank
+Electric Signal,Comedy,PG,977,1
+Crimson Garden,Comedy,PG-13,631,2
 ~~~
 
 <p align="center">
@@ -273,11 +273,11 @@ version rather than overwriting the old one, so a change to the SQL doesn't sile
 ### Bound query parameters
 
 ```sql
-SELECT * FROM actor WHERE actor_id = :id
+SELECT * FROM film WHERE film_id = :id
 ```
 
 ```http
-GET /q/actor_by_id?id=7
+GET /q/film_by_id?id=7
 ```
 
 Values are sent to the database separately from the SQL text, so they cannot be injected into it. Parameters can
@@ -416,8 +416,8 @@ and CI on every push. See [Development](#development) below.
 without building a service per query:
 
 ```http
-GET /q/actor_by_id?id=7
-GET /q/films_by_rating?rating=PG&max_length=90
+GET /q/film_by_id?id=7
+GET /q/example_top_films?top_n=5&category=Comedy
 ```
 
 **Reporting APIs.** Turn an existing analytical SQL report into a reusable endpoint that dashboards or scheduled
@@ -483,17 +483,17 @@ From a clone: `pip install -e ".[dev]"`. Or use Docker - see [below](#docker).
 Fastest: `queryapigate examples load && queryapigate serve` installs four worked [example APIs](documentation/EXAMPLES.md)
 (reporting, dashboard, export, partner) you can try, and `queryapigate examples unload` removes them again.
 
-Or, from a clone, the repository ships two sample SQLite databases and a couple of saved queries:
-
 ~~~bash
-cd examples
-cp db_connections.example.json db_connections.json
+queryapigate examples load
 queryapigate serve                            # http://127.0.0.1:5000
 ~~~
 
+The examples come with a small generated `examples` database (films, customers and rentals), so you can also run ad-hoc SQL
+straight away:
+
 ~~~bash
 curl -X POST 'http://127.0.0.1:5000/execute_sql?page_size=3' -H 'Content-Type: application/json' \
-     -d '{"sql": "SELECT * FROM actor WHERE actor_id > :min", "params": {"min": 10}, "connection_name": "sakila-sqlite"}'
+     -d '{"sql": "SELECT film_id, title, rating FROM film WHERE film_id > :min", "params": {"min": 10}, "connection_name": "examples"}'
 ~~~
 
 Open <http://127.0.0.1:5000/docs> for the interactive API reference, or <http://127.0.0.1:5000/ui> for a small
@@ -504,24 +504,26 @@ every supported database) and `saved_sql/`. Edit the file, set `"active": true`,
 
 ## Saving a query as an endpoint
 
+This uses the `examples` connection that `queryapigate examples load` sets up:
+
 ~~~bash
 curl -X PATCH http://127.0.0.1:5000/save_sql_to_file -H 'Content-Type: application/json' -d '{
-  "filename": "actor_by_id",
-  "sql_query": "SELECT * FROM actor WHERE actor_id = :id",
-  "query_parameters": {"id": {"type": "int", "min": 1, "max": 200, "description": "Actor id"}},
-  "connection_name": "sakila-sqlite",
-  "author": "me", "description": "Look up an actor"
+  "filename": "film_by_id",
+  "sql_query": "SELECT * FROM film WHERE film_id = :id",
+  "query_parameters": {"id": {"type": "int", "min": 1, "max": 60, "description": "Film id"}},
+  "connection_name": "examples",
+  "author": "me", "description": "Look up a film"
 }'
 
-curl 'http://127.0.0.1:5000/q/actor_by_id?id=7&format=yaml'
-curl 'http://127.0.0.1:5000/q/actor_by_id?id=0'
+curl 'http://127.0.0.1:5000/q/film_by_id?id=7&format=yaml'
+curl 'http://127.0.0.1:5000/q/film_by_id?id=0'
 # {"error": "Invalid parameters: id must be at least 1", "errors": {"id": "must be at least 1"}}
 ~~~
 
 Rules: `type` (`int`, `float`, `str`, `bool`), `default`, `required`, `enum`, `min`/`max`, `min_length`/`max_length`,
 `pattern` and `description` - see [the API reference](documentation/API.md#parameter-rules).
 
-Saving again under the same name adds version 2; `DELETE /saved_sql/actor_by_id?version=1` removes one version.
+Saving again under the same name adds version 2; `DELETE /saved_sql/film_by_id?version=1` removes one version.
 
 Add `"cache_ttl": 60` to cache a response for that many seconds (`X-Cache: HIT`/`MISS`, `ETag`, `Cache-Control`) -
 opt-in, and never used for a query that writes. See
@@ -715,12 +717,29 @@ observability are all useful areas. Please review [CONTRIBUTING.md](CONTRIBUTING
 
 ## Third-party components
 
-The wheel bundles the [H2 Database](https://h2database.com) JDBC driver (MPL 2.0 / EPL 1.0). The sample SQLite
-databases in `examples/` derive from the Sakila and Chinook sample datasets.
+The wheel bundles the [H2 Database](https://h2database.com) JDBC driver (MPL 2.0 / EPL 1.0). The example data is generated
+locally by `queryapigate examples load`; no third-party datasets are included.
 
 ## License
 
-[MIT](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE) © Anantha Raju C
+QueryAPIGate is **source-available**, under the
+[Functional Source License, Version 1.1, MIT Future License](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE)
+(`FSL-1.1-MIT`) © Anantha Raju C. It is not an OSI-approved open source license.
+
+In plain terms - the [LICENSE](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE) is the only authoritative text:
+
+- **You may** use, copy, modify and redistribute it for any purpose that is not a *Competing Use* - including running it
+  inside your own company, non-commercial education and research, and professional services you provide to someone who
+  is themselves licensed to use it.
+- **You may not** make it available to others in a commercial product or service that substitutes for QueryAPIGate or
+  offers the same or substantially similar functionality (for example, selling it, or hosting it as a paid service).
+- **Each version becomes MIT** on the second anniversary of the date it was released, and can then be used under MIT terms.
+- **Versions up to and including 0.6.1** were released under the MIT license and remain available under it (the
+  releases on PyPI: [`queryapigate`](https://pypi.org/project/queryapigate/) 0.5.0-0.6.1 and
+  [`sql2api`](https://pypi.org/project/sql2api/) 0.1.0-0.4.0).
+
+Need something the license does not cover, such as offering it as part of a hosted service? Get in touch - commercial
+licensing may be available. This is a summary, not legal advice.
 
 ## Contact
 

{queryapigate-0.6.0 → queryapigate-0.7.0}/README.md

@@ -4,7 +4,7 @@
 [![codecov](https://codecov.io/gh/AnanthaRajuC/QueryAPIGate/branch/main/graph/badge.svg)](https://codecov.io/gh/AnanthaRajuC/QueryAPIGate)
 [![PyPI](https://img.shields.io/pypi/v/queryapigate.svg)](https://pypi.org/project/queryapigate/)
 [![PyPI downloads](https://img.shields.io/pypi/dm/queryapigate.svg)](https://pypi.org/project/queryapigate/)
-[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE)
+[![License: FSL-1.1-MIT](https://img.shields.io/badge/license-FSL--1.1--MIT-blue.svg)](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE)
 ![Python](https://img.shields.io/badge/python-3.9%2B-blue)
 
 ### Turn SQL queries into secure, governed REST APIs.
@@ -21,13 +21,13 @@ serialization boilerplate for it.
 Write SQL. Configure the query. Apply access controls. Get an API.
 
 ~~~bash
-$ curl 'http://127.0.0.1:5000/q/actor_by_id?id=7'
-[{"actor_id": 7, "first_name": "GRACE", "last_name": "MOSTEL"}]
+$ curl 'http://127.0.0.1:5000/q/example_film_search?text=Harbor&page_size=2'
+[{"film_id":48,"title":"Broken Harbor","category":"Action","rating":"PG-13"},{"film_id":44,"title":"Electric Harbor","category":"Documentary","rating":"G"}]
 
-$ curl 'http://127.0.0.1:5000/q/films_by_rating?rating=PG&max_length=60&format=csv&page_size=2'
-film_id,title,rating,length
-410,HEAVEN FREEDOM,PG,48
-443,HURRICANE AFFAIR,PG,49
+$ curl 'http://127.0.0.1:5000/q/example_top_films?top_n=2&category=Comedy&format=csv'
+title,category,rating,rentals,rank
+Electric Signal,Comedy,PG,977,1
+Crimson Garden,Comedy,PG-13,631,2
 ~~~
 
 <p align="center">
@@ -213,11 +213,11 @@ version rather than overwriting the old one, so a change to the SQL doesn't sile
 ### Bound query parameters
 
 ```sql
-SELECT * FROM actor WHERE actor_id = :id
+SELECT * FROM film WHERE film_id = :id
 ```
 
 ```http
-GET /q/actor_by_id?id=7
+GET /q/film_by_id?id=7
 ```
 
 Values are sent to the database separately from the SQL text, so they cannot be injected into it. Parameters can
@@ -356,8 +356,8 @@ and CI on every push. See [Development](#development) below.
 without building a service per query:
 
 ```http
-GET /q/actor_by_id?id=7
-GET /q/films_by_rating?rating=PG&max_length=90
+GET /q/film_by_id?id=7
+GET /q/example_top_films?top_n=5&category=Comedy
 ```
 
 **Reporting APIs.** Turn an existing analytical SQL report into a reusable endpoint that dashboards or scheduled
@@ -423,17 +423,17 @@ From a clone: `pip install -e ".[dev]"`. Or use Docker - see [below](#docker).
 Fastest: `queryapigate examples load && queryapigate serve` installs four worked [example APIs](documentation/EXAMPLES.md)
 (reporting, dashboard, export, partner) you can try, and `queryapigate examples unload` removes them again.
 
-Or, from a clone, the repository ships two sample SQLite databases and a couple of saved queries:
-
 ~~~bash
-cd examples
-cp db_connections.example.json db_connections.json
+queryapigate examples load
 queryapigate serve                            # http://127.0.0.1:5000
 ~~~
 
+The examples come with a small generated `examples` database (films, customers and rentals), so you can also run ad-hoc SQL
+straight away:
+
 ~~~bash
 curl -X POST 'http://127.0.0.1:5000/execute_sql?page_size=3' -H 'Content-Type: application/json' \
-     -d '{"sql": "SELECT * FROM actor WHERE actor_id > :min", "params": {"min": 10}, "connection_name": "sakila-sqlite"}'
+     -d '{"sql": "SELECT film_id, title, rating FROM film WHERE film_id > :min", "params": {"min": 10}, "connection_name": "examples"}'
 ~~~
 
 Open <http://127.0.0.1:5000/docs> for the interactive API reference, or <http://127.0.0.1:5000/ui> for a small
@@ -444,24 +444,26 @@ every supported database) and `saved_sql/`. Edit the file, set `"active": true`,
 
 ## Saving a query as an endpoint
 
+This uses the `examples` connection that `queryapigate examples load` sets up:
+
 ~~~bash
 curl -X PATCH http://127.0.0.1:5000/save_sql_to_file -H 'Content-Type: application/json' -d '{
-  "filename": "actor_by_id",
-  "sql_query": "SELECT * FROM actor WHERE actor_id = :id",
-  "query_parameters": {"id": {"type": "int", "min": 1, "max": 200, "description": "Actor id"}},
-  "connection_name": "sakila-sqlite",
-  "author": "me", "description": "Look up an actor"
+  "filename": "film_by_id",
+  "sql_query": "SELECT * FROM film WHERE film_id = :id",
+  "query_parameters": {"id": {"type": "int", "min": 1, "max": 60, "description": "Film id"}},
+  "connection_name": "examples",
+  "author": "me", "description": "Look up a film"
 }'
 
-curl 'http://127.0.0.1:5000/q/actor_by_id?id=7&format=yaml'
-curl 'http://127.0.0.1:5000/q/actor_by_id?id=0'
+curl 'http://127.0.0.1:5000/q/film_by_id?id=7&format=yaml'
+curl 'http://127.0.0.1:5000/q/film_by_id?id=0'
 # {"error": "Invalid parameters: id must be at least 1", "errors": {"id": "must be at least 1"}}
 ~~~
 
 Rules: `type` (`int`, `float`, `str`, `bool`), `default`, `required`, `enum`, `min`/`max`, `min_length`/`max_length`,
 `pattern` and `description` - see [the API reference](documentation/API.md#parameter-rules).
 
-Saving again under the same name adds version 2; `DELETE /saved_sql/actor_by_id?version=1` removes one version.
+Saving again under the same name adds version 2; `DELETE /saved_sql/film_by_id?version=1` removes one version.
 
 Add `"cache_ttl": 60` to cache a response for that many seconds (`X-Cache: HIT`/`MISS`, `ETag`, `Cache-Control`) -
 opt-in, and never used for a query that writes. See
@@ -655,12 +657,29 @@ observability are all useful areas. Please review [CONTRIBUTING.md](CONTRIBUTING
 
 ## Third-party components
 
-The wheel bundles the [H2 Database](https://h2database.com) JDBC driver (MPL 2.0 / EPL 1.0). The sample SQLite
-databases in `examples/` derive from the Sakila and Chinook sample datasets.
+The wheel bundles the [H2 Database](https://h2database.com) JDBC driver (MPL 2.0 / EPL 1.0). The example data is generated
+locally by `queryapigate examples load`; no third-party datasets are included.
 
 ## License
 
-[MIT](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE) © Anantha Raju C
+QueryAPIGate is **source-available**, under the
+[Functional Source License, Version 1.1, MIT Future License](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE)
+(`FSL-1.1-MIT`) © Anantha Raju C. It is not an OSI-approved open source license.
+
+In plain terms - the [LICENSE](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE) is the only authoritative text:
+
+- **You may** use, copy, modify and redistribute it for any purpose that is not a *Competing Use* - including running it
+  inside your own company, non-commercial education and research, and professional services you provide to someone who
+  is themselves licensed to use it.
+- **You may not** make it available to others in a commercial product or service that substitutes for QueryAPIGate or
+  offers the same or substantially similar functionality (for example, selling it, or hosting it as a paid service).
+- **Each version becomes MIT** on the second anniversary of the date it was released, and can then be used under MIT terms.
+- **Versions up to and including 0.6.1** were released under the MIT license and remain available under it (the
+  releases on PyPI: [`queryapigate`](https://pypi.org/project/queryapigate/) 0.5.0-0.6.1 and
+  [`sql2api`](https://pypi.org/project/sql2api/) 0.1.0-0.4.0).
+
+Need something the license does not cover, such as offering it as part of a hosted service? Get in touch - commercial
+licensing may be available. This is a summary, not legal advice.
 
 ## Contact
 

{queryapigate-0.6.0 → queryapigate-0.7.0}/pyproject.toml

@@ -8,7 +8,7 @@ dynamic = ["version"]
 description = "Turn SQL into a REST API: run queries against MySQL, PostgreSQL, ClickHouse, SQLite or H2 over HTTP and get JSON, CSV, XML, YAML or XLSX back."
 readme = "README.md"
 requires-python = ">=3.9"
-license = "MIT"
+license = "FSL-1.1-MIT"
 authors = [{ name = "Anantha Raju C", email = "arcswdev@gmail.com" }]
 keywords = ["sql", "api", "rest", "flask", "database", "mysql", "postgresql", "clickhouse", "sqlite", "h2", "jdbc"]
 classifiers = [

{queryapigate-0.6.0 → queryapigate-0.7.0}/queryapigate/__init__.py

@@ -1,5 +1,5 @@
 """QueryAPIGate - expose SQL databases as a REST API."""
-__version__ = '0.6.0'
+__version__ = '0.7.0'
 
 from .app import create_app  # noqa: E402  (app imports __version__)
 

{queryapigate-0.6.0 → queryapigate-0.7.0}/queryapigate/apikeys.py

@@ -367,7 +367,11 @@ def _record_use(name):
     already use. _last_recorded_use is in-process only: it resets on restart, which just means the first
     request after one writes immediately - never a correctness problem, only ever slightly more eager."""
     now = time.monotonic()
-    if now - _last_recorded_use.get(name, 0.0) < _USE_RECORD_INTERVAL:
+    # "Never recorded" must be None, not 0.0: time.monotonic() has an undefined starting point (on Linux, boot), so
+    # on a host up for under _USE_RECORD_INTERVAL seconds `now - 0.0` is already inside the window and a key's
+    # first use would be silently throttled away - which is exactly what happened on freshly booted CI runners.
+    last = _last_recorded_use.get(name)
+    if last is not None and now - last < _USE_RECORD_INTERVAL:
         return
     _last_recorded_use[name] = now
     with store.lock:

{queryapigate-0.6.0 → queryapigate-0.7.0/queryapigate.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: queryapigate
-Version: 0.6.0
+Version: 0.7.0
 Summary: Turn SQL into a REST API: run queries against MySQL, PostgreSQL, ClickHouse, SQLite or H2 over HTTP and get JSON, CSV, XML, YAML or XLSX back.
 Author-email: Anantha Raju C <arcswdev@gmail.com>
-License-Expression: MIT
+License-Expression: FSL-1.1-MIT
 Project-URL: Homepage, https://github.com/AnanthaRajuC/QueryAPIGate
 Project-URL: Documentation, https://AnanthaRajuC.github.io/QueryAPIGate/
 Project-URL: Repository, https://github.com/AnanthaRajuC/QueryAPIGate
@@ -64,7 +64,7 @@ Dynamic: license-file
 [![codecov](https://codecov.io/gh/AnanthaRajuC/QueryAPIGate/branch/main/graph/badge.svg)](https://codecov.io/gh/AnanthaRajuC/QueryAPIGate)
 [![PyPI](https://img.shields.io/pypi/v/queryapigate.svg)](https://pypi.org/project/queryapigate/)
 [![PyPI downloads](https://img.shields.io/pypi/dm/queryapigate.svg)](https://pypi.org/project/queryapigate/)
-[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE)
+[![License: FSL-1.1-MIT](https://img.shields.io/badge/license-FSL--1.1--MIT-blue.svg)](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE)
 ![Python](https://img.shields.io/badge/python-3.9%2B-blue)
 
 ### Turn SQL queries into secure, governed REST APIs.
@@ -81,13 +81,13 @@ serialization boilerplate for it.
 Write SQL. Configure the query. Apply access controls. Get an API.
 
 ~~~bash
-$ curl 'http://127.0.0.1:5000/q/actor_by_id?id=7'
-[{"actor_id": 7, "first_name": "GRACE", "last_name": "MOSTEL"}]
+$ curl 'http://127.0.0.1:5000/q/example_film_search?text=Harbor&page_size=2'
+[{"film_id":48,"title":"Broken Harbor","category":"Action","rating":"PG-13"},{"film_id":44,"title":"Electric Harbor","category":"Documentary","rating":"G"}]
 
-$ curl 'http://127.0.0.1:5000/q/films_by_rating?rating=PG&max_length=60&format=csv&page_size=2'
-film_id,title,rating,length
-410,HEAVEN FREEDOM,PG,48
-443,HURRICANE AFFAIR,PG,49
+$ curl 'http://127.0.0.1:5000/q/example_top_films?top_n=2&category=Comedy&format=csv'
+title,category,rating,rentals,rank
+Electric Signal,Comedy,PG,977,1
+Crimson Garden,Comedy,PG-13,631,2
 ~~~
 
 <p align="center">
@@ -273,11 +273,11 @@ version rather than overwriting the old one, so a change to the SQL doesn't sile
 ### Bound query parameters
 
 ```sql
-SELECT * FROM actor WHERE actor_id = :id
+SELECT * FROM film WHERE film_id = :id
 ```
 
 ```http
-GET /q/actor_by_id?id=7
+GET /q/film_by_id?id=7
 ```
 
 Values are sent to the database separately from the SQL text, so they cannot be injected into it. Parameters can
@@ -416,8 +416,8 @@ and CI on every push. See [Development](#development) below.
 without building a service per query:
 
 ```http
-GET /q/actor_by_id?id=7
-GET /q/films_by_rating?rating=PG&max_length=90
+GET /q/film_by_id?id=7
+GET /q/example_top_films?top_n=5&category=Comedy
 ```
 
 **Reporting APIs.** Turn an existing analytical SQL report into a reusable endpoint that dashboards or scheduled
@@ -483,17 +483,17 @@ From a clone: `pip install -e ".[dev]"`. Or use Docker - see [below](#docker).
 Fastest: `queryapigate examples load && queryapigate serve` installs four worked [example APIs](documentation/EXAMPLES.md)
 (reporting, dashboard, export, partner) you can try, and `queryapigate examples unload` removes them again.
 
-Or, from a clone, the repository ships two sample SQLite databases and a couple of saved queries:
-
 ~~~bash
-cd examples
-cp db_connections.example.json db_connections.json
+queryapigate examples load
 queryapigate serve                            # http://127.0.0.1:5000
 ~~~
 
+The examples come with a small generated `examples` database (films, customers and rentals), so you can also run ad-hoc SQL
+straight away:
+
 ~~~bash
 curl -X POST 'http://127.0.0.1:5000/execute_sql?page_size=3' -H 'Content-Type: application/json' \
-     -d '{"sql": "SELECT * FROM actor WHERE actor_id > :min", "params": {"min": 10}, "connection_name": "sakila-sqlite"}'
+     -d '{"sql": "SELECT film_id, title, rating FROM film WHERE film_id > :min", "params": {"min": 10}, "connection_name": "examples"}'
 ~~~
 
 Open <http://127.0.0.1:5000/docs> for the interactive API reference, or <http://127.0.0.1:5000/ui> for a small
@@ -504,24 +504,26 @@ every supported database) and `saved_sql/`. Edit the file, set `"active": true`,
 
 ## Saving a query as an endpoint
 
+This uses the `examples` connection that `queryapigate examples load` sets up:
+
 ~~~bash
 curl -X PATCH http://127.0.0.1:5000/save_sql_to_file -H 'Content-Type: application/json' -d '{
-  "filename": "actor_by_id",
-  "sql_query": "SELECT * FROM actor WHERE actor_id = :id",
-  "query_parameters": {"id": {"type": "int", "min": 1, "max": 200, "description": "Actor id"}},
-  "connection_name": "sakila-sqlite",
-  "author": "me", "description": "Look up an actor"
+  "filename": "film_by_id",
+  "sql_query": "SELECT * FROM film WHERE film_id = :id",
+  "query_parameters": {"id": {"type": "int", "min": 1, "max": 60, "description": "Film id"}},
+  "connection_name": "examples",
+  "author": "me", "description": "Look up a film"
 }'
 
-curl 'http://127.0.0.1:5000/q/actor_by_id?id=7&format=yaml'
-curl 'http://127.0.0.1:5000/q/actor_by_id?id=0'
+curl 'http://127.0.0.1:5000/q/film_by_id?id=7&format=yaml'
+curl 'http://127.0.0.1:5000/q/film_by_id?id=0'
 # {"error": "Invalid parameters: id must be at least 1", "errors": {"id": "must be at least 1"}}
 ~~~
 
 Rules: `type` (`int`, `float`, `str`, `bool`), `default`, `required`, `enum`, `min`/`max`, `min_length`/`max_length`,
 `pattern` and `description` - see [the API reference](documentation/API.md#parameter-rules).
 
-Saving again under the same name adds version 2; `DELETE /saved_sql/actor_by_id?version=1` removes one version.
+Saving again under the same name adds version 2; `DELETE /saved_sql/film_by_id?version=1` removes one version.
 
 Add `"cache_ttl": 60` to cache a response for that many seconds (`X-Cache: HIT`/`MISS`, `ETag`, `Cache-Control`) -
 opt-in, and never used for a query that writes. See
@@ -715,12 +717,29 @@ observability are all useful areas. Please review [CONTRIBUTING.md](CONTRIBUTING
 
 ## Third-party components
 
-The wheel bundles the [H2 Database](https://h2database.com) JDBC driver (MPL 2.0 / EPL 1.0). The sample SQLite
-databases in `examples/` derive from the Sakila and Chinook sample datasets.
+The wheel bundles the [H2 Database](https://h2database.com) JDBC driver (MPL 2.0 / EPL 1.0). The example data is generated
+locally by `queryapigate examples load`; no third-party datasets are included.
 
 ## License
 
-[MIT](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE) © Anantha Raju C
+QueryAPIGate is **source-available**, under the
+[Functional Source License, Version 1.1, MIT Future License](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE)
+(`FSL-1.1-MIT`) © Anantha Raju C. It is not an OSI-approved open source license.
+
+In plain terms - the [LICENSE](https://github.com/AnanthaRajuC/QueryAPIGate/blob/main/LICENSE) is the only authoritative text:
+
+- **You may** use, copy, modify and redistribute it for any purpose that is not a *Competing Use* - including running it
+  inside your own company, non-commercial education and research, and professional services you provide to someone who
+  is themselves licensed to use it.
+- **You may not** make it available to others in a commercial product or service that substitutes for QueryAPIGate or
+  offers the same or substantially similar functionality (for example, selling it, or hosting it as a paid service).
+- **Each version becomes MIT** on the second anniversary of the date it was released, and can then be used under MIT terms.
+- **Versions up to and including 0.6.1** were released under the MIT license and remain available under it (the
+  releases on PyPI: [`queryapigate`](https://pypi.org/project/queryapigate/) 0.5.0-0.6.1 and
+  [`sql2api`](https://pypi.org/project/sql2api/) 0.1.0-0.4.0).
+
+Need something the license does not cover, such as offering it as part of a hosted service? Get in touch - commercial
+licensing may be available. This is a summary, not legal advice.
 
 ## Contact
 

{queryapigate-0.6.0 → queryapigate-0.7.0}/tests/test_api_keys.py

@@ -412,6 +412,22 @@ class LastUsedTests(AppTestCase):
                          headers={'X-API-Key': key})
         self.assertIn('last_used_at', self.listed())
 
+    def test_first_use_records_even_when_the_host_booted_seconds_ago(self):
+        # time.monotonic() counts from an undefined point - on Linux, boot - and CI runners are fresh VMs, so the
+        # clock can read a few seconds. A "never recorded" default of 0.0 then looks like a write a moment ago, and
+        # the first use was throttled away: last_used_at never appeared. Simulate that clock without waiting.
+        key = self.create_key('reporting', connections=['a'])
+        fresh_boot = mock.Mock(monotonic=lambda: 5.0)
+        with mock.patch.object(apikeys, 'time', fresh_boot):
+            self.client.post('/execute_sql', json={'sql': 'SELECT * FROM t', 'connection_name': 'a'},
+                             headers={'X-API-Key': key})
+            self.assertIn('last_used_at', self.listed())
+            with mock.patch.object(apikeys, '_write') as spy:  # and the throttle still holds on that clock
+                for _ in range(3):
+                    self.client.post('/execute_sql', json={'sql': 'SELECT * FROM t', 'connection_name': 'a'},
+                                     headers={'X-API-Key': key})
+                self.assertEqual(spy.call_count, 0)
+
     def test_rapid_reuse_is_throttled_to_one_write(self):
         key = self.create_key('reporting', connections=['a'])
         with mock.patch.object(apikeys, '_write') as spy:

queryapigate-0.6.0/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Anantha Raju C
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.