Merge pull request #5 from DataMini/release-please--branches--main--changes--next

release: 3.1.0

Author: frei-l

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "3.0.0"
+  ".": "3.1.0"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 68
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/datamini%2Fasktable-bef7cc9067d22f118adcf91a2687ca2df91cc4c74892e764dea10d729f3b96ba.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/datamini%2Fasktable-f8d4f4ee9ccccf65054df0c205156f6022a8d207441b1494fa56bd950b44593b.yml

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 3.1.0 (2024-10-13)
+
+Full Changelog: [v3.0.0...v3.1.0](https://github.com/DataMini/asktable-python/compare/v3.0.0...v3.1.0)
+
+### Features
+
+* **api:** api update ([#10](https://github.com/DataMini/asktable-python/issues/10)) ([4cbdddc](https://github.com/DataMini/asktable-python/commit/4cbdddc99448537b9bb986ce647ca048ab807413))
+* **api:** api update ([#11](https://github.com/DataMini/asktable-python/issues/11)) ([f8e9649](https://github.com/DataMini/asktable-python/commit/f8e9649d2d956ad02735ad67f107576d1d9a7b35))
+* **api:** api update ([#12](https://github.com/DataMini/asktable-python/issues/12)) ([8ac4185](https://github.com/DataMini/asktable-python/commit/8ac41859c959e8685213202e85d25b1280fca209))
+* **api:** api update ([#13](https://github.com/DataMini/asktable-python/issues/13)) ([c7f3137](https://github.com/DataMini/asktable-python/commit/c7f31371476e5896dcf230b95f7645f2b5fa42d0))
+* **api:** api update ([#7](https://github.com/DataMini/asktable-python/issues/7)) ([230366d](https://github.com/DataMini/asktable-python/commit/230366dd4f8c19062e7850df73220a025213e221))
+* **api:** api update ([#8](https://github.com/DataMini/asktable-python/issues/8)) ([234cd71](https://github.com/DataMini/asktable-python/commit/234cd71631cb05afac371bc2ad741514d71b15ab))
+* **api:** api update ([#9](https://github.com/DataMini/asktable-python/issues/9)) ([0956b01](https://github.com/DataMini/asktable-python/commit/0956b0100295717552c61de84b38900b57b36984))
+
+
+### Chores
+
+* **internal:** codegen related update ([#4](https://github.com/DataMini/asktable-python/issues/4)) ([df56af1](https://github.com/DataMini/asktable-python/commit/df56af1e43756716339314650602d8cf3b00b781))
+* **internal:** codegen related update ([#6](https://github.com/DataMini/asktable-python/issues/6)) ([6403369](https://github.com/DataMini/asktable-python/commit/640336989f2bf2157a6817dccb06a7f030c45346))
+
 ## 3.0.0 (2024-09-30)
 
 Full Changelog: [v0.0.1-alpha.0...v3.0.0](https://github.com/DataMini/asktable-python/compare/v0.0.1-alpha.0...v3.0.0)

CONTRIBUTING.md

@@ -2,9 +2,13 @@
 
 ### With Rye
 
-We use [Rye](https://rye.astral.sh/) to manage dependencies so we highly recommend [installing it](https://rye.astral.sh/guide/installation/) as it will automatically provision a Python environment with the expected Python version.
+We use [Rye](https://rye.astral.sh/) to manage dependencies because it will automatically provision a Python environment with the expected Python version. To set it up, run:
 
-After installing Rye, you'll just have to run this command:
+```sh
+$ ./scripts/bootstrap
+```
+
+Or [install Rye manually](https://rye.astral.sh/guide/installation/) and run:
 
 ```sh
 $ rye sync --all-features
@@ -39,17 +43,17 @@ modify the contents of the `src/asktable/lib/` and `examples/` directories.
 
 All files in the `examples/` directory are not modified by the generator and can be freely edited or added to.
 
-```bash
+```py
 # add an example to examples/<your-example>.py
 
 #!/usr/bin/env -S rye run python
 …
 ```
 
-```
-chmod +x examples/<your-example>.py
+```sh
+$ chmod +x examples/<your-example>.py
 # run the example against your api
-./examples/<your-example>.py
+$ ./examples/<your-example>.py
 ```
 
 ## Using the repository from source
@@ -58,8 +62,8 @@ If you’d like to use the repository from source, you can either install from g
 
 To install via git:
 
-```bash
-pip install git+ssh://git@github.com/DataMini/asktable-python.git
+```sh
+$ pip install git+ssh://git@github.com/DataMini/asktable-python.git
 ```
 
 Alternatively, you can build from source and install the wheel file:
@@ -68,29 +72,29 @@ Building this package will create two files in the `dist/` directory, a `.tar.gz
 
 To create a distributable version of the library, all you have to do is run this command:
 
-```bash
-rye build
+```sh
+$ rye build
 # or
-python -m build
+$ python -m build
 ```
 
 Then to install:
 
 ```sh
-pip install ./path-to-wheel-file.whl
+$ pip install ./path-to-wheel-file.whl
 ```
 
 ## Running tests
 
 Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
 
-```bash
+```sh
 # you will need npm installed
-npx prism mock path/to/your/openapi.yml
+$ npx prism mock path/to/your/openapi.yml
 ```
 
-```bash
-rye run pytest
+```sh
+$ ./scripts/test
 ```
 
 ## Linting and formatting
@@ -100,14 +104,14 @@ This repository uses [ruff](https://github.com/astral-sh/ruff) and
 
 To lint:
 
-```bash
-rye run lint
+```sh
+$ ./scripts/lint
 ```
 
 To format and fix all ruff issues automatically:
 
-```bash
-rye run format
+```sh
+$ ./scripts/format
 ```
 
 ## Publishing and releases

README.md

@@ -28,10 +28,8 @@ from asktable import Asktable
 
 client = Asktable()
 
-project = client.sys.projects.create(
-    name="name",
-)
-print(project.id)
+datasource = client.datasources.list()
+print(datasource.items)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -51,10 +49,8 @@ client = AsyncAsktable()
 
 
 async def main() -> None:
-    project = await client.sys.projects.create(
-        name="name",
-    )
-    print(project.id)
+    datasource = await client.datasources.list()
+    print(datasource.items)
 
 
 asyncio.run(main())
@@ -87,8 +83,9 @@ from asktable import Asktable
 client = Asktable()
 
 try:
-    client.sys.projects.create(
-        name="name",
+    client.datasources.create(
+        access_config={},
+        engine="mysql",
     )
 except asktable.APIConnectionError as e:
     print("The server could not be reached")
@@ -132,8 +129,9 @@ client = Asktable(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).sys.projects.create(
-    name="name",
+client.with_options(max_retries=5).datasources.create(
+    access_config={},
+    engine="mysql",
 )
 ```
 
@@ -157,8 +155,9 @@ client = Asktable(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).sys.projects.create(
-    name="name",
+client.with_options(timeout=5.0).datasources.create(
+    access_config={},
+    engine="mysql",
 )
 ```
 
@@ -198,13 +197,14 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from asktable import Asktable
 
 client = Asktable()
-response = client.sys.projects.with_raw_response.create(
-    name="name",
+response = client.datasources.with_raw_response.create(
+    access_config={},
+    engine="mysql",
 )
 print(response.headers.get('X-My-Header'))
 
-project = response.parse()  # get the object that `sys.projects.create()` would have returned
-print(project.id)
+datasource = response.parse()  # get the object that `datasources.create()` would have returned
+print(datasource.id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/DataMini/asktable-python/tree/main/src/asktable/_response.py) object.
@@ -218,8 +218,9 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.sys.projects.with_streaming_response.create(
-    name="name",
+with client.datasources.with_streaming_response.create(
+    access_config={},
+    engine="mysql",
 ) as response:
     print(response.headers.get("X-My-Header"))
 
@@ -321,3 +322,7 @@ print(asktable.__version__)
 ## Requirements
 
 Python 3.7 or higher.
+
+## Contributing
+
+See [the contributing documentation](./CONTRIBUTING.md).