Skip to content

chore: remove alpha designation for 1.0.0 ga #8

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.

Sign up for GitHub

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

Open
mishamilovidov wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −12
Open

chore: remove alpha designation for 1.0.0 ga #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 1 addition & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,19 @@
![Python CI](https://github.com/adobe/aio-lib-sandbox-python/workflows/Python%20CI/badge.svg)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-lib-sandbox-python/main.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-lib-sandbox-python/)
![Status](https://img.shields.io/badge/status-alpha-orange.svg)

Python SDK for Adobe Runtime Sandboxes.

A **sandbox** is an ephemeral, isolated compute environment. You create one, run commands and read/write files inside it over a WebSocket session, then destroy it.

> [!WARNING]
> **Alpha.** This SDK is in active alpha development. The API surface and authentication model may change without notice. Pin exact versions; install only with `--pre`.
## Pre-requisites

To use this library, you must have Sandboxes enabled for your Runtime namespace. Please contact Michael Goberling ([email protected]) or Cosmin Stanciu ([email protected]) to request this.

## Install

```bash
pip install --pre aio-lib-sandbox
pip install aio-lib-sandbox
```

## Quickstart
Expand Down
8 changes: 2 additions & 6 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ pip install hatch
Or set a specific version directly:

```bash
hatch version 0.1.0a1
hatch version 1.0.0
```

> This edits `src/aio_lib_sandbox/__init__.py` in place because `pyproject.toml` uses Hatch's dynamic version path. Verify the new version with `hatch version`.
Expand Down Expand Up @@ -77,11 +77,7 @@ pip install hatch
And confirm the new version is installable:

```bash
pip install --pre aio-lib-sandbox==<new-version>
pip install aio-lib-sandbox==<new-version>
```

8. **Create a GitHub Release** from the new tag on the [Releases page](https://github.com/adobe/aio-lib-sandbox-python/releases). Summarise what changed in the release notes.

## Notes

- This package is in **alpha**. All versions use a PEP 440 pre-release suffix (e.g. `0.1.0a0`). This means `pip install aio-lib-sandbox` will not pick up the package by default — users must pass `--pre`. Keep the `a0` / `a1` suffix until the API is stable.
2 changes: 1 addition & 1 deletion src/aio_lib_sandbox/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

from __future__ import annotations

__version__ = "0.1.0a9"
__version__ = "1.0.0"

from .constants import PROTOCOL_VERSION
from .errors import (
Expand Down
Loading