Skip to content

Commit

Permalink
feat(api): api update (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-app[bot] authored and stainless-bot committed Oct 13, 2024
1 parent d9fc13f commit 3cc79b2
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 19 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Arcade Engine Python API library

[![PyPI version](https://img.shields.io/pypi/v/arcade_engine.svg)](https://pypi.org/project/arcade_engine/)
[![PyPI version](https://img.shields.io/pypi/v/arcade-py.svg)](https://pypi.org/project/arcade-py/)

The Arcade Engine Python library provides convenient access to the Arcade Engine REST API from any Python 3.7+
application. The library includes type definitions for all request params and response fields,
Expand All @@ -15,13 +15,10 @@ The REST API documentation can be found on [arcade-ai.com](https://arcade-ai.com
## Installation

```sh
# install from the production repo
pip install git+ssh://[email protected]/ArcadeAI/arcade-py.git
# install from PyPI
pip install --pre arcade-py
```

> [!NOTE]
> Once this package is [published to PyPI](https://app.stainlessapi.com/docs/guides/publish), this will become: `pip install --pre arcade_engine`
## Usage

The full API of this library can be found in [api.md](api.md).
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[project]
name = "arcade_engine"
name = "arcade-py"
version = "0.0.1-alpha.0"
description = "The official Python library for the arcade-engine API"
dynamic = ["readme"]
Expand Down
12 changes: 6 additions & 6 deletions requirements-dev.lock
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
annotated-types==0.6.0
# via pydantic
anyio==4.4.0
# via arcade-engine
# via arcade-py
# via httpx
argcomplete==3.1.2
# via nox
Expand All @@ -27,7 +27,7 @@ dirty-equals==0.6.0
distlib==0.3.7
# via virtualenv
distro==1.8.0
# via arcade-engine
# via arcade-py
exceptiongroup==1.1.3
# via anyio
filelock==3.12.4
Expand All @@ -37,7 +37,7 @@ h11==0.14.0
httpcore==1.0.2
# via httpx
httpx==0.25.2
# via arcade-engine
# via arcade-py
# via respx
idna==3.4
# via anyio
Expand Down Expand Up @@ -65,7 +65,7 @@ pluggy==1.3.0
py==1.11.0
# via pytest
pydantic==2.7.1
# via arcade-engine
# via arcade-py
pydantic-core==2.18.2
# via pydantic
pygments==2.18.0
Expand All @@ -87,15 +87,15 @@ six==1.16.0
# via python-dateutil
sniffio==1.3.0
# via anyio
# via arcade-engine
# via arcade-py
# via httpx
time-machine==2.9.0
tomli==2.0.1
# via mypy
# via pytest
typing-extensions==4.8.0
# via anyio
# via arcade-engine
# via arcade-py
# via mypy
# via pydantic
# via pydantic-core
Expand Down
12 changes: 6 additions & 6 deletions requirements.lock
Original file line number Diff line number Diff line change
Expand Up @@ -12,34 +12,34 @@
annotated-types==0.6.0
# via pydantic
anyio==4.4.0
# via arcade-engine
# via arcade-py
# via httpx
certifi==2023.7.22
# via httpcore
# via httpx
distro==1.8.0
# via arcade-engine
# via arcade-py
exceptiongroup==1.1.3
# via anyio
h11==0.14.0
# via httpcore
httpcore==1.0.2
# via httpx
httpx==0.25.2
# via arcade-engine
# via arcade-py
idna==3.4
# via anyio
# via httpx
pydantic==2.7.1
# via arcade-engine
# via arcade-py
pydantic-core==2.18.2
# via pydantic
sniffio==1.3.0
# via anyio
# via arcade-engine
# via arcade-py
# via httpx
typing-extensions==4.8.0
# via anyio
# via arcade-engine
# via arcade-py
# via pydantic
# via pydantic-core

0 comments on commit 3cc79b2

Please sign in to comment.