Skip to content

Commit

Permalink
Update readmes and makefiles
Browse files Browse the repository at this point in the history
  • Loading branch information
JordonPhillips committed Dec 22, 2023
1 parent 7252499 commit 8669e6f
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 21 deletions.
9 changes: 3 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -50,26 +50,23 @@ test-protocols: install-python-components generate-protocol-tests run-protocol-t

## Runs formatters/fixers/linters for the python packages.
lint-py: pants
./pants fix lint python-packages/smithy-python::
./pants fix lint python-packages/aws-smithy-python::
./pants fix lint python-packages/smithy-core::
./pants fix lint python-packages/smithy-http::
./pants fix lint python-packages/smithy-aws-core::


## Runs checkers for the python packages.
check-py: pants
./pants check python-packages/smithy-python::
./pants check python-packages/aws-smithy-python::
./pants check python-packages/smithy-core::
./pants check python-packages/smithy-http::
./pants check python-packages/smithy-aws-core::


## Runs tests for the python packages.
test-py: pants
./pants test python-packages/smithy-python::
./pants test python-packages/aws-smithy-python::
./pants test python-packages/smithy-core::
./pants test python-packages/smithy-http::
./pants test python-packages/smithy-aws-core::


## Runs formatters/fixers/linters/checkers/tests for the python packages.
Expand Down
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,12 +147,15 @@ helper libraries have been published you won't need to install them manually.

### Core Modules and Interfaces

The `smithy-python` package provides the core modules and interfaces required
to build a service client. These basic modules include things like:
an HTTP/1.1 and HTTP/2 client implementation, retry strategies, etc.

The `aws-smithy-python` package provides implementations of those interfaces
for AWS, such as SigV4 signers.
* `smithy-core` provides transport-agnostic core modules and interfaces
required to build a service client. This includes things like retry
strategies, URI interfaces, shared types, etc.
* `smithy-http` provides HTTP core modules and interfaces required to build
HTTP service clients, including optional HTTP client implementations.
Currently it provides two async HTTP clients that are useable with the
`aiohttp` or `awscrt` optional dependency sets respectively.
* `smithy-aws-core` provides implementations of those interfaces for AWS, such
as SigV4 signers.

### What are the design goals of this project?

Expand Down Expand Up @@ -256,10 +259,10 @@ Important to note is those pairs of colons. These are pants
[targets](https://www.pantsbuild.org/docs/targets#target-addresses). The double
colon is a special target that means "everything". So running exactly what's
listed above will run those goals on every python file or other relevant file.
You can also target just `smithy_python`, for example, with
`./pants check python-packages/smithy-python/smithy_python:source`, or even
You can also target just `smithy_core`, for example, with
`./pants check python-packages/smithy-python/smithy_core:source`, or even
individual files with something like
`./pants check python-packages/smithy-python/smithy_python/interfaces/http.py:../source`.
`./pants check python-packages/smithy-python/smithy_core/interfaces/identity.py:../source`.
To list what targets are available in a directory, run
`./pants list path/to/dir:`. For more detailed information, see the
[docs](https://www.pantsbuild.org/docs/targets#target-addresses).
Expand Down
7 changes: 4 additions & 3 deletions codegen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ clients.
* If `black` is installed in the version of python found on the path, it will
be used to format the generated code.
* If `mypy` is installed in the version of python found on the path, it will
be used to check the generated code. For mypy to pass, the `smithy_python`
package will need to be installed. To install those into your active environment,
run `make install-python-components` from the repository root.
be used to check the generated code. For mypy to pass, the `smithy_core` and
`smithy_http` packages will need to be installed. To install those into your
active environment, run `make install-python-components` from the repository
root.

### Building the generator

Expand Down
2 changes: 1 addition & 1 deletion python-packages/smithy-aws-core/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ python_distribution(
":readme",
":notice",
"python-packages/smithy-aws-core/smithy_aws_core:source",
"python-packages/smithy-python:dist",
"python-packages/smithy-core:dist",
],
provides=python_artifact(
name="smithy_aws_core",
Expand Down
2 changes: 1 addition & 1 deletion python-packages/smithy-core/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ classifiers = [
dependencies = []

[project.urls]
source = "https://github.com/awslabs/smithy-python/tree/develop/python-packages/aws-smithy-python"
source = "https://github.com/awslabs/smithy-python/tree/develop/python-packages/smithy-core"
changelog = "https://github.com/awslabs/smithy-python/blob/develop/CHANGES.md"

[tool.setuptools]
Expand Down
2 changes: 1 addition & 1 deletion python-packages/smithy-http/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ awscrt = [
]

[project.urls]
source = "https://github.com/awslabs/smithy-python/tree/develop/python-packages/aws-smithy-python"
source = "https://github.com/awslabs/smithy-python/tree/develop/python-packages/smithy-http"
changelog = "https://github.com/awslabs/smithy-python/blob/develop/CHANGES.md"

[tool.setuptools]
Expand Down

0 comments on commit 8669e6f

Please sign in to comment.