open-feature / python-sdk-contrib

Community contributions for hooks and reference providers in python
https://openfeature.dev
11 stars 11 forks source link

docs: Flesh out readme #85

Closed agardnerIT closed 5 months ago

agardnerIT commented 6 months ago

This PR

Adds a little bit more code to the sample to make it more copy / paste friendly.

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.87%. Comparing base (d8e10c7) to head (d940abf). Report is 31 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #85 +/- ## ========================================== + Coverage 90.55% 91.87% +1.31% ========================================== Files 8 12 +4 Lines 180 443 +263 ========================================== + Hits 163 407 +244 - Misses 17 36 +19 ``` | [Flag](https://app.codecov.io/gh/open-feature/python-sdk-contrib/pull/85/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-feature) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/open-feature/python-sdk-contrib/pull/85/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-feature) | `?` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-feature#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

beeme1mr commented 6 months ago

Hey @agardnerIT, would you be willing to add a Python tutorial to the docs? We could link to the tutorial from this repo once it's ready.