Patch Api v1 #1

biglovisa · 2021-01-22T14:33:43Z

What

Adding v1 of the package

Why

To make our Python using customers happy

SDK Release Checklist

Have you added an integration test for the changes?
Have you built the gem locally and made queries against it successfully?
Did you update the changelog?
Did you bump the package version?
For breaking changes, did you plan for the release of the new SDK versions and deploy the API to production?

Outstanding work

write integration tests for Preferences
write integration tests for Orders
Set up badge fury
Publish the package to PiPy and set up publish.yml

biglovisa · 2021-01-28T00:49:02Z

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:


Configuration for using the pre-commit package and black code formatter.

biglovisa · 2021-01-28T00:49:25Z

README.md

@@ -32,27 +32,24 @@ pip install patch



Read through the README to get an idea of the interface!

biglovisa · 2021-01-28T00:50:46Z

README.md

 ```

 The `api_client` will be used to instantiate other API objects for Patch resources, for example the `OrdersApi`:

 ```
 import patch_api
-from patch_api.api.orders_api import OrdersApi
+from patch_api.api.orders_api import OrdersApi as Orders


We talked about dropping the {Resource}Api from the API models and I tried to implement it but couldn't figure out how to do it well, so specifying to use aliased imports was a workaround to get a cleaner interface. LMK what you think.

hmm maybe we can import these resources on __init__.py but rename them, and then expose/make them public by using __all__. 🤔
Not sure if it would work, would need some testing.

I tried doing that in code in a template in client-code-generation, but the variables weren't being evaluated properly? I can try again though, it feels like it should be possible. Worst case scenario we can have a template that we have to manually update when new API resources are being added.

biglovisa · 2021-01-28T00:51:38Z

README.md

-configuration = patch_api.Configuration(api_key=os.environ.get('SANDBOX_API_KEY'))
-api_client = patch_api.ApiClient(configuration)
-orders_api = OrdersApi(api_client=api_client)
+api_client = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))


The api_client instance can be reused, but each resource interface instance (Orders, Estimates, etc) need to be instantiated with an api_client instance.

is there a way to pass the api_key to the api resources?
Maybe as public configuration variable?

We could do something like:

patch_api.api_key = "blah"

This could live on __init__.py.

See this example: https://github.com/stripe/stripe-python/blob/master/stripe/__init__.py

Yes.... that is much better and we don't have to init/pass around api_client objects all over the place. Will look at this today!

thdaraujo

nice job, thanks for working on this!

I left a couple of comments and suggestions, let me know what you think!

README.md

Makefile

git_push.sh

test/test_create_preference_request.py

test/test_estimates_api.py

test/test_meta_index_object.py

test/test_projects_api.py

thdaraujo · 2021-01-29T01:28:07Z

README.md

-configuration = patch_api.Configuration(api_key=os.environ.get('SANDBOX_API_KEY'))
-api_client = patch_api.ApiClient(configuration)
-orders_api = OrdersApi(api_client=api_client)
+api_client = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))


is there a way to pass the api_key to the api resources?
Maybe as public configuration variable?

We could do something like:

patch_api.api_key = "blah"

This could live on __init__.py.

See this example: https://github.com/stripe/stripe-python/blob/master/stripe/__init__.py

thdaraujo · 2021-01-29T01:43:57Z

README.md

+from patch_api.api.orders_api import OrdersApi as Orders
+
+api_client = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
+orders_api = Orders(api_client=api_client)


I think one thing that could be done here is to implement the __getattr__ method and use it to chain the calls to the api resources. It works pretty much like ruby's method_missing.

I'm pretty sure it would allow us to do something like:

patch_api.orders.create_order(some_attrs)

By implementing __get_attr__, you could return a new instance of the requested ApiResource (in this case, OrdersApi) and pass in self.api_client or the self.api_key from the parent object.

This could make this interface a little cleaner.

Here's an example from the chargify python api: https://github.com/ipmb/chargify-python/blob/ed6e49559da53f36006800bc3355d31696b01175/chargify.py#L110

Here's an explanation of how it works: https://blog.rmotr.com/python-magic-methods-and-getattr-75cf896b3f88

Let me know if that makes sense!

…python into lovisa/python-v1

thdaraujo

looks good to me, but left a few comments.

Makefile

test/test_orders_api.py

Co-authored-by: Thiago Araujo <thd.araujo@gmail.com>

biglovisa added 4 commits January 22, 2021 15:30

add github configuration

659831d

Code, tests, etc

258b89a

Merge branch 'main' into lovisa/python-v1

2783785

Add Orders integration tests

e21867e

biglovisa self-assigned this Jan 22, 2021

biglovisa added 3 commits January 25, 2021 12:40

Preferences specs

6b5d25a

Do not include photos

a5d89ab

Add pre-commit hook

e538a90

biglovisa force-pushed the lovisa/python-v1 branch from 1dd962f to e538a90 Compare January 25, 2021 16:02

biglovisa added 2 commits January 25, 2021 17:27

more unwanted model files

01c9dc2

Do not require Configuration object for init ApiClient with api_key

f7679cf

biglovisa force-pushed the lovisa/python-v1 branch from 66c82cf to f7679cf Compare January 27, 2021 14:16

wip

672df0c

biglovisa added the Needs Review The PR is ready to be reviewed label Jan 28, 2021

biglovisa requested a review from thdaraujo January 28, 2021 00:44

biglovisa commented Jan 28, 2021

View reviewed changes

.pre-commit-config.yaml

@@ -0,0 +1,5 @@

repos:

Copy link

Contributor Author

biglovisa Jan 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Configuration for using the pre-commit package and black code formatter.

biglovisa commented Jan 28, 2021

View reviewed changes

README.md

@@ -32,27 +32,24 @@ pip install patch

Copy link

Contributor Author

biglovisa Jan 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Read through the README to get an idea of the interface!

biglovisa commented Jan 28, 2021

View reviewed changes

biglovisa force-pushed the lovisa/python-v1 branch from eb8941e to da99e9c Compare January 28, 2021 00:55

Update makefile and readme examples

7fbf49f

biglovisa force-pushed the lovisa/python-v1 branch from da99e9c to 7fbf49f Compare January 28, 2021 16:33

thdaraujo approved these changes Jan 29, 2021

View reviewed changes

biglovisa added 3 commits January 29, 2021 12:37

strengthen tests

f6967db

Specify version

65e53e7

Delete unused test filesimprove pre-cimmit

e58c0b9

biglovisa force-pushed the lovisa/python-v1 branch from 89147aa to e58c0b9 Compare January 29, 2021 20:23

biglovisa added 2 commits January 29, 2021 13:25

Delete unused test filesimprove pre-cimmit

9a50112

Merge branch 'lovisa/python-v1' of github.com:patch-technology/patch-…

3a63e6b

…python into lovisa/python-v1

biglovisa force-pushed the lovisa/python-v1 branch from 1171e3a to 24c8c23 Compare January 29, 2021 20:35

Run tests on push

fe8831e

biglovisa force-pushed the lovisa/python-v1 branch from 24c8c23 to fe8831e Compare January 29, 2021 20:35

biglovisa added 2 commits January 29, 2021 13:52

Ignore line too long errors"

2b10d2e

Api fixes

5b433e8

biglovisa force-pushed the lovisa/python-v1 branch from 3884675 to e9d14fa Compare January 30, 2021 00:37

update Readme

ca9a692

biglovisa force-pushed the lovisa/python-v1 branch from e9d14fa to ca9a692 Compare January 30, 2021 00:41

biglovisa added 2 commits January 29, 2021 17:43

Remove unused models

3a2c3c3

remove factories

70bf760

biglovisa force-pushed the lovisa/python-v1 branch from 4f3539f to e1ff181 Compare January 30, 2021 02:20

Remove opts arg

456ba16

biglovisa force-pushed the lovisa/python-v1 branch from e1ff181 to 456ba16 Compare January 30, 2021 02:21

biglovisa requested a review from thdaraujo January 30, 2021 02:23

thdaraujo approved these changes Feb 2, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

test/test_orders_api.py Outdated Show resolved Hide resolved

test/test_orders_api.py Outdated Show resolved Hide resolved

Update Makefile

0716e42

Co-authored-by: Thiago Araujo <thd.araujo@gmail.com>

biglovisa force-pushed the lovisa/python-v1 branch from 01544e4 to 0716e42 Compare February 2, 2021 00:54

Alphabetize imports

a416e26

biglovisa merged commit 160fe9e into main Feb 2, 2021

biglovisa deleted the lovisa/python-v1 branch February 2, 2021 18:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Patch Api v1 #1

Patch Api v1 #1

biglovisa commented Jan 22, 2021 •

edited

Loading

biglovisa Jan 28, 2021

biglovisa Jan 28, 2021

biglovisa Jan 28, 2021

thdaraujo Jan 29, 2021 •

edited

Loading

biglovisa Jan 29, 2021

biglovisa Jan 28, 2021

thdaraujo Jan 29, 2021

biglovisa Jan 29, 2021

thdaraujo left a comment

thdaraujo Jan 29, 2021

thdaraujo Jan 29, 2021 •

edited

Loading

thdaraujo left a comment

Patch Api v1 #1

Patch Api v1 #1

Conversation

biglovisa commented Jan 22, 2021 • edited Loading

What

Why

SDK Release Checklist

Outstanding work

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thdaraujo Jan 29, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thdaraujo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thdaraujo Jan 29, 2021 • edited Loading

Choose a reason for hiding this comment

thdaraujo left a comment

Choose a reason for hiding this comment

biglovisa commented Jan 22, 2021 •

edited

Loading

thdaraujo Jan 29, 2021 •

edited

Loading

thdaraujo Jan 29, 2021 •

edited

Loading