Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release: 0.1.0-alpha.10 #43

Merged
merged 9 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file modified .devcontainer/Dockerfile
100755 → 100644
Empty file.
Empty file modified .devcontainer/devcontainer.json
100755 → 100644
Empty file.
Empty file modified .github/workflows/ci.yml
100755 → 100644
Empty file.
Empty file modified .github/workflows/publish-pypi.yml
100755 → 100644
Empty file.
Empty file modified .github/workflows/release-doctor.yml
100755 → 100644
Empty file.
Empty file modified .gitignore
100755 → 100644
Empty file.
Empty file modified .python-version
100755 → 100644
Empty file.
2 changes: 1 addition & 1 deletion .release-please-manifest.json
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.1.0-alpha.9"
".": "0.1.0-alpha.10"
}
2 changes: 1 addition & 1 deletion .stats.yml
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
configured_endpoints: 27
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/clear-street%2Fstudio-sdk-66efc857b146cfd0808fb37e5913e8ce46ee44fd0eac54154cfbc340d197585d.yml
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/clear-street%2Fstudio-sdk-414d28e743994ae591921b9df65e07bbd8d423d847d9607a0363c510d6d79e36.yml
Empty file modified Brewfile
100755 → 100644
Empty file.
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# Changelog

## 0.1.0-alpha.10 (2024-10-04)

Full Changelog: [v0.1.0-alpha.9...v0.1.0-alpha.10](https://github.com/clear-street/studio-sdk-python/compare/v0.1.0-alpha.9...v0.1.0-alpha.10)

### Features

* **api:** Add DMA and Stop Limit order support ([#45](https://github.com/clear-street/studio-sdk-python/issues/45)) ([1d8b0f5](https://github.com/clear-street/studio-sdk-python/commit/1d8b0f543dab7d35d6908583edbfb026e51d34ea))


### Chores

* add docstrings to raw response properties ([#42](https://github.com/clear-street/studio-sdk-python/issues/42)) ([f3c5945](https://github.com/clear-street/studio-sdk-python/commit/f3c594585a75c230018666923cab99c6570ad76d))
* **internal:** add support for parsing bool response content ([#49](https://github.com/clear-street/studio-sdk-python/issues/49)) ([fd1db20](https://github.com/clear-street/studio-sdk-python/commit/fd1db2031cdec661134ec10b0094c93e9489ede9))
* **internal:** codegen related update ([#46](https://github.com/clear-street/studio-sdk-python/issues/46)) ([094f3bf](https://github.com/clear-street/studio-sdk-python/commit/094f3bf0f68e2ac0143cc677222da2f289eecd33))
* **internal:** codegen related update ([#47](https://github.com/clear-street/studio-sdk-python/issues/47)) ([e01fdcf](https://github.com/clear-street/studio-sdk-python/commit/e01fdcfa63265e92171fc1502f5c298e8d2b07ac))
* **internal:** codegen related update ([#48](https://github.com/clear-street/studio-sdk-python/issues/48)) ([025b0ba](https://github.com/clear-street/studio-sdk-python/commit/025b0bace9e15f2faea93f960408a202ca500861))


### Documentation

* **readme:** add section on determining installed version ([#44](https://github.com/clear-street/studio-sdk-python/issues/44)) ([cb5137b](https://github.com/clear-street/studio-sdk-python/commit/cb5137bb1c742b9a5143d5e094328e114807d967))

## 0.1.0-alpha.9 (2024-09-05)

Full Changelog: [v0.1.0-alpha.8...v0.1.0-alpha.9](https://github.com/clear-street/studio-sdk-python/compare/v0.1.0-alpha.8...v0.1.0-alpha.9)
Expand Down
52 changes: 28 additions & 24 deletions CONTRIBUTING.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -31,25 +35,25 @@ $ pip install -r requirements-dev.lock

## Modifying/Adding code

Most of the SDK is generated code, and any modified code will be overridden on the next generation. The
`src/studio_sdk/lib/` and `examples/` directories are exceptions and will never be overridden.
Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
result in merge conflicts between manual patches and changes from the generator. The generator will never
modify the contents of the `src/studio_sdk/lib/` and `examples/` directories.

## Adding and running examples

All files in the `examples/` directory are not modified by the Stainless generator and can be freely edited or
added to.
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
Expand All @@ -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://[email protected]/clear-street/studio-sdk-python.git
```sh
$ pip install git+ssh://[email protected]/clear-street/studio-sdk-python.git
```

Alternatively, you can build from source and install the wheel file:
Expand All @@ -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
Expand All @@ -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
Expand Down
Empty file modified LICENSE
100755 → 100644
Empty file.
15 changes: 15 additions & 0 deletions README.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,21 @@ We take backwards-compatibility seriously and work hard to ensure you can rely o

We are keen for your feedback; please open an [issue](https://www.github.com/clear-street/studio-sdk-python/issues) with questions, bugs, or suggestions.

### Determining the installed version

If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.

You can determine the version that is being used at runtime with:

```py
import studio_sdk
print(studio_sdk.__version__)
```

## Requirements

Python 3.7 or higher.

## Contributing

See [the contributing documentation](./CONTRIBUTING.md).
Empty file modified SECURITY.md
100755 → 100644
Empty file.
Empty file modified api.md
100755 → 100644
Empty file.
Empty file modified bin/check-release-environment
100755 → 100644
Empty file.
Empty file modified bin/publish-pypi
100755 → 100644
Empty file.
Empty file modified examples/.keep
100755 → 100644
Empty file.
Empty file modified mypy.ini
100755 → 100644
Empty file.
Empty file modified noxfile.py
100755 → 100644
Empty file.
2 changes: 1 addition & 1 deletion pyproject.toml
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "clear-street-studio-sdk"
version = "0.1.0-alpha.9"
version = "0.1.0-alpha.10"
description = "The official Python library for the studio-sdk API"
dynamic = ["readme"]
license = "Apache-2.0"
Expand Down
Empty file modified release-please-config.json
100755 → 100644
Empty file.
6 changes: 3 additions & 3 deletions requirements-dev.lock
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ markdown-it-py==3.0.0
# via rich
mdurl==0.1.2
# via markdown-it-py
mypy==1.10.1
mypy==1.11.2
mypy-extensions==1.0.0
# via mypy
nodeenv==1.8.0
Expand All @@ -70,7 +70,7 @@ pydantic-core==2.18.2
# via pydantic
pygments==2.18.0
# via rich
pyright==1.1.374
pyright==1.1.380
pytest==7.1.1
# via pytest-asyncio
pytest-asyncio==0.21.1
Expand All @@ -80,7 +80,7 @@ pytz==2023.3.post1
# via dirty-equals
respx==0.20.2
rich==13.7.1
ruff==0.5.6
ruff==0.6.5
setuptools==68.2.2
# via nodeenv
six==1.16.0
Expand Down
Empty file modified requirements.lock
100755 → 100644
Empty file.
Empty file modified scripts/utils/ruffen-docs.py
100755 → 100644
Empty file.
Empty file modified src/studio_minus_sdk/lib/.keep
100755 → 100644
Empty file.
Empty file modified src/studio_minus_sdk_minus_try_minus_to_minus_fix/lib/.keep
100755 → 100644
Empty file.
Empty file modified src/studio_sdk/__init__.py
100755 → 100644
Empty file.
Loading
Loading