-
Notifications
You must be signed in to change notification settings - Fork 66
docs: cannabilize sphinx documentation into main README #355
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…- just a placeholder for now
for more information, see https://pre-commit.ci
…client-python into docs/cannabilize-sphinx
|
|
||
|  [](https://coveralls.io/github/Unleash/unleash-client-python?branch=main) [](https://badge.fury.io/py/UnleashClient)  [](https://opensource.org/licenses/MIT) | ||
|
|
||
| Unleash is a private, secure, and scalable [feature management platform](https://www.getunleash.io/) built to reduce the risk of releasing new features and accelerate software development. This server-side Python SDK is designed to help you integrate with Unleash and evaluate feature flags inside your application. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The intro here is shamelessly stolen from the Node SDK. I don't know if we want this or not but it feels like a nice way to ease into the docs
| ## Installation | ||
|
|
||
| Check out the package on [Pypi](https://pypi.org/project/UnleashClient/)! | ||
| ### Install the Unleash Client in your project |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a TON of ways of installing packages in Python. I know in node we list yarn and npm. For Python I don't think it's worth detailing every single one, since most Python programmers can extrapolate from pip out to their choice of package manager (it's pip all the way down anyway)
|
|
||
| ### Initialization | ||
|
|
||
| You must initialize the SDK before you use it. Note that until the SDK has synchronized with the API, all features will evaluate to `false` unless |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's no way to force a sync in the Python SDK
melindafekete
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @sighphyre this looks great!
Co-authored-by: Melinda Fekete <[email protected]>
This collapses all the docs in the SDK into the README. The Sphinx documentation was really difficult to discover if you didn't know where to look and users shouldn't have to fish around on the Internet to get critical info on the SDK (and honestly I'm tired of dealing with Slack questions that could just be written down)
Changes
TODO