Skip to content

Commit 3ab71b1

Browse files
committed
update readme
1 parent 4708e71 commit 3ab71b1

File tree

1 file changed

+12
-24
lines changed

1 file changed

+12
-24
lines changed

README.md

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,27 @@ make test
2424

2525
## E2E testing and Using the Aptos CLI
2626

27-
* Download the [Aptos CLI](https://aptos.dev/tools/aptos-cli/install-cli/).
27+
* Download and install the [Aptos CLI](https://aptos.dev/tools/aptos-cli/use-cli/running-a-local-network).
2828
* Set the environment variable `APTOS_CLI_PATH` to the full path of the CLI.
2929
* Retrieve the [Aptos Core Github Repo](https://github.com/aptos-labs/aptos-core) (git clone https://github.com/aptos-labs/aptos-core)
3030
* Set the environment variable `APTOS_CORE_REPO` to the full path of the Repository.
31-
* `make examples_cli`
31+
* `make integration_test`
3232

33-
We of course allow you to do this a bit more manually by:
33+
You can do this a bit more manually by:
3434

3535
First, run a local testnet (run this from the root of aptos-core):
3636

3737
```bash
38-
cargo run -p aptos -- node run-local-testnet --force-restart --assume-yes
38+
aptos node run-local-testnet --force-restart --assume-yes --with-indexer-api
3939
```
4040

4141
Next, tell the end-to-end tests to talk to this locally running testnet:
4242

4343
```bash
44-
export APTOS_NODE_URL="http://127.0.0.1:8080/v1"
44+
export APTOS_CORE_REPO="/path/to/repo"
4545
export APTOS_FAUCET_URL="http://127.0.0.1:8081"
46+
export APTOS_INDEXER_URL="http://127.0.0.1:8090/v1/graphql"
47+
export APTOS_NODE_URL="http://127.0.0.1:8080/v1"
4648
```
4749

4850
Finally run the tests:
@@ -51,13 +53,15 @@ Finally run the tests:
5153
make examples
5254
```
5355

54-
Note: These end-to-end tests are tested against a node built from the same commit as part of CI, not devnet. For examples tested against devnet, see `developer-docs-site/static/examples/python/` from the root of the repo.
56+
Integration Testing Using the Aptos CLI:
5557

56-
### Integration Testing Using the Aptos CLI
5758
```bash
58-
make examples_cli
59+
make integration_test
5960
```
6061

62+
> [!NOTE]
63+
> The Python SDK does not require the Indexer, if you would prefer to test without it, unset or do not set the environmental variable `APTOS_INDEXER_URL` and exclude `--with-indexer-api` from running the aptos node software.
64+
6165
## Autoformatting
6266
```bash
6367
make fmt
@@ -74,22 +78,6 @@ make lint
7478
* Set the environment variable `APTOS_CLI_PATH` to the full path of the CLI.
7579
* `poetry run python -m aptos_sdk.cli` and set the appropriate command-line parameters
7680

77-
## Generating types
78-
The Python `openapi-python-client` tool cannot parse references. Therefore there are three options:
79-
80-
- Use swagger-cli to dereference, gain a type explosion, and still have missing types
81-
- Live without missing types
82-
- Write a pure python implementation with no autogenerated code
83-
84-
Currently the team is moving forward with pure python, but leaves the following notes for the curious:
85-
86-
```bash
87-
npm install -g @apidevtools/swagger-cli
88-
swagger-cli bundle --dereference ../../../api/doc/v0/openapi.yaml -t yaml > openapi.yaml
89-
python3 -m openapi_python_client generate --path openapi.yaml
90-
mv aptos-dev-api-specification-client/aptos_dev_api_specification_client/ aptos_sdk/openapi
91-
```
92-
9381
## Semantic versioning
9482
This project follows [semver](https://semver.org/) as closely as possible
9583

0 commit comments

Comments
 (0)