Skip to content

Commit

Permalink
Merge branch 'master' into pyteal_version
Browse files Browse the repository at this point in the history
  • Loading branch information
joe-p committed Sep 24, 2024
2 parents 782bd61 + dcf9c79 commit 9c33db1
Show file tree
Hide file tree
Showing 5 changed files with 144 additions and 36 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

<!--next-version-placeholder-->

## v1.1.1 (2023-10-10)

### Documentation

* Re trigger pypi release ([#245](https://github.com/algorand-devrel/beaker/issues/245)) ([`86fafeb`](https://github.com/algorand-devrel/beaker/commit/86fafebcef504fd9af4bbaabefb7c032b3c692d8))

## v1.1.0 (2023-10-09)

### Feature

* Bumping algokit utils, pyteal; removing algoexplorer as api provider ([`c1295b4`](https://github.com/algorand-devrel/beaker/commit/c1295b468150c92cd8be867786101e02f41efefe))

## v1.0.1 (2023-05-23)
### Fix
* Resolves issue when using ApplicationClient.prepare with a custom TransactionSigner, resolves #213 ([#229](https://github.com/algorand-devrel/beaker/issues/229)) ([`55bd4fc`](https://github.com/algorand-devrel/beaker/commit/55bd4fc2fad4b01d3c64ad71de5bef6d48139cdd))
Expand Down
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,14 @@ Beaker

Beaker is a smart contract development framework for [PyTeal](https://github.com/algorand/pyteal).



&nbsp;

&nbsp;

&nbsp;



## Hello, Beaker


```py
from pyteal import *
from beaker import *
Expand Down Expand Up @@ -45,8 +40,8 @@ app_client = client.ApplicationClient(
app_id, app_addr, txid = app_client.create()
print(
f"""Deployed app in txid {txid}
App ID: {app_id}
Address: {app_addr}
App ID: {app_id}
Address: {app_addr}
"""
)

Expand All @@ -64,25 +59,24 @@ You can install from pip:

`pip install beaker-pyteal`

Or from github directly (no promises on stability):
Or from github directly (no promises on stability):

`pip install git+https://github.com/algorand-devrel/beaker`

# Dev Environment
# Dev Environment

Requires a local network running to compile and test contracts.

Install [AlgoKit](https://github.com/algorandfoundation/algokit-cli#install)

and start it
and start it

```sh
$ algokit localnet start
$ algokit localnet start
$ algokit localnet status
```

## Front End

## Front End

See [Beaker TS](https://github.com/algorand-devrel/beaker-ts) to generate a front end client for a Beaker App.

Expand Down
2 changes: 1 addition & 1 deletion examples/source_mapping/test_demo.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from feature_gates import FeatureGates # type: ignore[import]
from feature_gates import FeatureGates # type: ignore[import-untyped]

from tests.conftest import check_application_artifacts_output_stability

Expand Down
108 changes: 100 additions & 8 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

38 changes: 24 additions & 14 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,30 +1,26 @@
[tool.poetry]
name = "beaker-pyteal"
version = "1.0.1"
version = "1.1.1"
description = "A Framework for building PyTeal Applications"
license = "MIT"
authors = ["Ben Guidarelli <[email protected]>"]
readme = "README.md"
homepage = "https://beaker.algo.xyz"
repository = "https://github.com/algorand-devrel/beaker"
keywords = ["pyteal", "algorand"]
classifiers = [
"Development Status :: 2 - Pre-Alpha",
]
packages = [
{ include = "beaker" },
]
classifiers = ["Development Status :: 5 - Production/Stable"]
packages = [{ include = "beaker" }]

[tool.poetry.dependencies]
python = "^3.10"
pyteal = "^0.26.1"
py-algorand-sdk = ">=2.0.0"
algokit-utils = "^1.0.2"
py-algorand-sdk = ">=2.5.0"
algokit-utils = "^2.2.1"

[tool.poetry.group.dev.dependencies]
pytest = "^7.2.0"
mypy = "^1.0.0"
black = {extras = ["d"], version = "^22.12.0"}
black = { extras = ["d"], version = "^22.12.0" }
pytest-cov = "^4.0.0"
pre-commit = "^2.20.0"
python-semantic-release = "^7.32.2"
Expand Down Expand Up @@ -68,11 +64,25 @@ exclude_lines = [
]

[tool.ruff]
select = ["E", "F", "ANN", "UP", "N", "C", "B", "YTT", "W", "FBT", "Q", "RUF", "I"]
select = [
"E",
"F",
"ANN",
"UP",
"N",
"C",
"B",
"YTT",
"W",
"FBT",
"Q",
"RUF",
"I",
]
ignore = [
"ANN101", # missing type for self parameter
"ANN102", # missing type for cls parameter
"E501", # line too long - black takes care of this for us
"E501", # line too long - black takes care of this for us
]
# Exclude a variety of commonly ignored directories.
exclude = [
Expand All @@ -94,10 +104,10 @@ target-version = "py310"

[tool.ruff.per-file-ignores]
"tests/state_test.py" = ["ANN001", "ANN201", "ANN401"]
"beaker/lib/*.py" = ["N802"] # lowercase function names
"beaker/lib/*.py" = ["N802"] # lowercase function names

[tool.ruff.flake8-annotations]
mypy-init-return = true

[tool.ruff.isort]
forced-separate = ["tests", "examples"]
forced-separate = ["tests", "examples"]

0 comments on commit 9c33db1

Please sign in to comment.