Skip to content

Commit 2e471a9

Browse files
standy66standy66
committed
Release 0.1.2
1 parent 21a5491 commit 2e471a9

7 files changed

+339
-4
lines changed

‎.travis.yml

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ stages:
1111
env:
1212
- PYTHON_IMAGE="python:3.6"
1313
- PYTHON_IMAGE="python:3.7-rc"
14+
- PYTHON_IMAGE="standy/pypy:3.6-6.1.0"
1415

1516
script:
1617
- ./ci/run_tests_in_docker.sh $PYTHON_IMAGE

‎CHANGELOG.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Release 0.1.2
2+
3+
* Fix unit tests on Python 3.7
4+
5+
## Release 0.1.0
6+
7+
* Implement immediate mode
8+
9+
## Release 0.0.1
10+
11+
* Initial release

‎LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md

+88-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,92 @@
11
# purerpc
2+
3+
[![Build Status](https://travis-ci.org/standy66/purerpc.png?branch=master)](https://travis-ci.org/standy66/purerpc)
4+
25
Asynchronous pure Python gRPC server and client implementation using
36
[curio](https://github.com/dabeaz/curio) and [hyper-h2](https://github.com/python-hyper/hyper-h2)
47

5-
For server example, see `misc/greeter/main.py`
8+
## Requirements
9+
10+
* CPython >= 3.6
11+
* PyPy >= 3.6
12+
13+
## Installation
14+
15+
```bash
16+
pip install purerpc
17+
```
18+
19+
## protoc plugin
20+
21+
purerpc has protoc plugin to generate service definition and stubs:
22+
23+
```bash
24+
protoc --purerpc_out=. --python_out=. -I. greeter.proto
25+
```
26+
27+
or, if you installed `grpcio_tool` package:
28+
29+
```bash
30+
python -m grpc_tools.protoc --purerpc_out=. --python_out=. -I. greeter.proto
31+
```
32+
33+
## Usage
34+
35+
NOTE: `greeter_grpc` module is generated by purerpc `protoc` plugin
36+
37+
### Server
38+
39+
```python
40+
from greeter_pb2 import HelloRequest, HelloReply
41+
from greeter_grpc import GreeterServicer
42+
from purerpc import Server
43+
44+
45+
class Greeter(GreeterServicer):
46+
async def SayHello(self, message):
47+
return HelloReply(message="Hello, " + message.name)
48+
49+
async def SayHelloToMany(self, input_messages):
50+
async for message in input_messages:
51+
yield HelloReply(message=f"Hello, {message.name}")
52+
53+
54+
server = Server(50055)
55+
server.add_service(Greeter().service)
56+
server.serve()
57+
```
58+
59+
### Client
60+
61+
```python
62+
import curio
63+
from greeter_pb2 import HelloRequest, HelloReply
64+
from greeter_grpc import GreeterStub
65+
from purerpc import Channel
66+
67+
68+
async def gen():
69+
for i in range(5):
70+
yield HelloRequest(name=str(i))
71+
72+
73+
async def main():
74+
channel = Channel("localhost", 50055)
75+
# This is optional, will be run automatically on the first request
76+
await channel.connect()
77+
stub = GreeterStub(channel)
78+
79+
reply = await stub.SayHello(HelloRequest(name="World"))
80+
print(reply.message)
81+
82+
async for reply in stub.SayHelloToMany(gen()):
83+
print(reply.message)
84+
85+
86+
if __name__ == "__main__":
87+
curio.run(main)
88+
```
89+
90+
You can mix server and client code, for example make a server that requests something using purerpc from another server, etc.
91+
92+
More examples in `misc/` folder

‎ci/docker_build_template.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ fi
1717
BASE_IMAGE=${2}
1818

1919
mkdir -p .dockerfiles
20-
DOCKERFILE="./.dockerfiles/${BASE_IMAGE}.dockerfile"
20+
DOCKERFILE="./.dockerfiles/${BUILD_IMAGE_TAG}.dockerfile"
2121
sed 's,%BASE_IMAGE%,'${BASE_IMAGE}',g' ./ci/template.dockerfile > ${DOCKERFILE}
2222

2323
echo "Building dockerfile ${DOCKERFILE}:"

‎ci/run_tests_in_docker.sh

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ set -e
44

55
BASE_IMAGE="$1"
66
BUILD_TAG=${BASE_IMAGE/:/-}
7+
BUILD_TAG=${BUILD_TAG/\//-}
78
echo $BUILD_TAG
89

910
./ci/docker_build_template.sh "$BUILD_TAG" "$BASE_IMAGE"

‎setup.py

+35-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,47 @@
1+
import re
2+
import os
13
from setuptools import setup, find_packages
24

35

6+
def read(*names, **kwargs):
7+
with open(os.path.join(os.path.dirname(__file__), *names), "r") as fin:
8+
return fin.read()
9+
10+
411
def main():
512
console_scripts = ['protoc-gen-purerpc=purerpc.protoc_plugin.plugin:main']
613
setup(
714
name="purerpc",
8-
version="0.1.0",
9-
author="Andrew Stepanov",
15+
version="0.1.2",
16+
license="Apache License Version 2.0",
1017
description="Asynchronous pure python gRPC server and client implementation using curio "
1118
"and hyper-h2.",
19+
long_description='%s\n%s' % (
20+
re.compile('^.. start-badges.*^.. end-badges', re.M | re.S).sub('', read('README.md')),
21+
re.sub(':[a-z]+:`~?(.*?)`', r'``\1``', read('CHANGELOG.md'))
22+
),
23+
author="Andrew Stepanov",
24+
url="https://github.com/standy66/purerpc",
25+
classifiers=[
26+
"Development Status :: 4 - Beta",
27+
"Intended Audience :: Developers",
28+
"License :: OSI Approved :: Apache Software License",
29+
"Operating System :: MacOS :: MacOS X",
30+
"Operating System :: POSIX :: Linux",
31+
"Programming Language :: Python",
32+
"Programming Language :: Python :: 3 :: Only",
33+
"Programming Language :: Python :: 3.6",
34+
"Programming Language :: Python :: 3.7",
35+
"Programming Language :: Python :: Implementation :: CPython",
36+
"Programming Language :: Python :: Implementation :: PyPy",
37+
"Topic :: Internet",
38+
"Topic :: Software Development :: Libraries",
39+
"Topic :: System :: Networking",
40+
],
41+
keywords=[
42+
"async", "await", "grpc", "pure-python", "pypy", "network",
43+
"rpc", "http2",
44+
],
1245
packages=find_packages('src'),
1346
package_dir={'': 'src'},
1447
test_suite="tests",

0 commit comments

Comments
 (0)