From f5d2c5cc27225133ec37e2b8d631d0814b030125 Mon Sep 17 00:00:00 2001 From: Abhi591 Date: Thu, 20 Jun 2024 18:13:12 +0530 Subject: [PATCH] chore: release ready, added mandatory non source-code files --- CHANGELOG.md | 91 ++++++++++++++++++++ CODE_OF_CONDUCT.md | 76 +++++++++++++++++ CONTRIBUTING.md | 42 ++++++++++ LICENSE | 202 +++++++++++++++++++++++++++++++++++++++++++++ MANIFEST.in | 5 ++ NOTICE | 18 ++++ README.md | 140 +++++++++++++++++++++++++++++++ 7 files changed, 574 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 NOTICE create mode 100644 README.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0e49a1d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,91 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [1.0.0] - 2024-06-20 +### Added +- First release of VWO Feature Management and Experimentation capabilities + ```python + from vwo import init + + options = { + 'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key + 'account_id': '123456' # VWO Account ID + } + + vwo_client = init(options) + + # set user context + user_context = {'id': 'unique_user_id'} + # returns a flag object + get_flag = vwo_client.get_flag('feature_key', user_context) + # check if flag is enabled + is_enabled = get_flag.is_enabled() + # get varible + int_var = get_flag.get_variable('int_variable_key', 'default_value') + + # track event + vwo_client.track_event('event_name', user_context, event_properties) + + # set attribute + vwo_client.set_attribute('attribute_key', 'attribute_value', user_context) + ``` + +- **Storage** + + ```python + from vwo.packages.storage.connector import StorageConnector + class UserStorage(StorageConnector): + def get(self, key: str, user_id: str): + return client_db.get(f"{key}_{user_id}") + + def set(self, value: dict): + key = f"{value.get('featureKey')}_{value.get('user')}" + client_db[key] = { + 'rolloutKey': value.get('rolloutKey'), + 'rolloutVariationId': value.get('rolloutVariationId'), + 'rolloutId': value.get('rolloutId'), + 'experimentKey': value.get('experimentKey'), + 'experimentVariationId': value.get('experimentVariationId'), + 'experimentId': value.get('experimentId'), + } + return True + + options = { + 'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key + 'account_id': '123456', # VWO Account ID + 'storage': UserStorage() + } + + vwo_client = init(options) + ``` + +- **Log messages** + + ```python + options = { + 'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key + 'account_id': '123456', # VWO Account ID + 'logger': { + 'level': 'DEBUG', + 'prefix': 'VWO-FME-PYTHON-SDK' + } + } + + vwo_client = init(options) + ``` + +- **Polling support** + + ```python + options = { + 'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key + 'account_id': '123456', # VWO Account ID + 'poll_interval': 5000 # in milliseconds + } + + vwo_client = init(options) + ``` + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..c5d0fc6 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at dev@wingify.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9b93c00 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +## Contributing to VWO Feature Management and Experimentation SDK for Python + +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: + +- Reporting a bug +- Discussing the current state of the code +- Submitting a fix +- Proposing new features + +### We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests + +Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: + +1. Fork the repo and create your branch from `master`. +2. If you've added code that should be tested, add tests. +3. Ensure the test suite passes. +4. Make sure your code lints. +5. Open a pull request! + +### Any contributions you make will be under the Apache 2.0 Software License + +When you submit code changes, your submissions are understood to be under the same [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0) that covers the project. Feel free to contact the maintainers if that's a concern. + +### Report bugs using GitHub issues + +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/wingify/vwo-fme-python-sdk/issues); it's that easy! + +**Note**: Write bug reports with detail, background, and sample code + +**Great Bug Reports** tend to have: + +- A quick summary and/or background +- Steps to reproduce + - Be specific! + - Give sample code if you can. +- What you expected would happen +- What actually happens +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) + +### License + +By contributing, you agree that your contributions will be licensed under its Apache 2.0 License. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..77d833e --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 Wingify Software Pvt. Ltd. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..943b0f2 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,5 @@ +include README.md +include requirements.txt +include requirements-dev.txt +include LICENSE +recursive-exclude tests * diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..e1e0105 --- /dev/null +++ b/NOTICE @@ -0,0 +1,18 @@ +Copyright 2024 Wingify Software Pvt. Ltd. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +Wingify VWO FME Python SDK + +This product includes software developed at +Wingify Software Pvt. Ltd. (https://wingify.com/). diff --git a/README.md b/README.md new file mode 100644 index 0000000..ac62abb --- /dev/null +++ b/README.md @@ -0,0 +1,140 @@ +## VWO Feature Management and Experimentation SDK for Python + +[![PyPI version](https://badge.fury.io/py/vwo-fme-python-sdk.svg)](https://pypi.org/project/vwo-fme-python-sdk) +[![CI](https://github.com/wingify/vwo-fme-python-sdk/workflows/CI/badge.svg?branch=master)](https://github.com/wingify/vwo-fme-python-sdk/actions?query=workflow%3ACI) +[![codecov](https://codecov.io/gh/wingify/vwo-fme-python-sdk/branch/master/graph/badge.svg?token=)](https://codecov.io/gh/wingify/vwo-fme-python-sdk) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0) + +This open source library allows you to A/B Test your Website at server-side. + +## Requirements + +* Works with Python: 3.6 onwards. + +## Installation + +It's recommended you use [virtualenv](https://virtualenv.pypa.io/en/latest/) to create isolated Python environments. + +```bash +pip install vwo-fme-python-sdk +``` + +## Basic usage + +```python +from vwo import init + +options = { + 'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key + 'account_id': '123456' # VWO Account ID +} + +vwo_client = init(options) + +# set user context +user_context = {'id': 'unique_user_id'} +# returns a flag object +get_flag = vwo_client.get_flag('feature_key', user_context) +# check if flag is enabled +is_enabled = get_flag.is_enabled() +# get varible +int_var = get_flag.get_variable('int_variable_key', 'default_value') + +# track event +vwo_client.track_event('event_name', user_context, event_properties) + +# set attribute +vwo_client.set_attribute('attribute_key', 'attribute_value', user_context) +``` + +- **Storage** + +```python +from vwo import StorageConnector +class UserStorage(StorageConnector): + def get(self, key: str, user_id: str): + return client_db.get(f"{key}_{user_id}") + + def set(self, value: dict): + key = f"{value.get('featureKey')}_{value.get('user')}" + client_db[key] = { + 'rolloutKey': value.get('rolloutKey'), + 'rolloutVariationId': value.get('rolloutVariationId'), + 'rolloutId': value.get('rolloutId'), + 'experimentKey': value.get('experimentKey'), + 'experimentVariationId': value.get('experimentVariationId'), + 'experimentId': value.get('experimentId'), + } + return True + +options = { + 'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key + 'account_id': '123456', # VWO Account ID + 'storage': UserStorage() +} + +vwo_client = init(options) +``` + +- **Log messages** + +```python +from vwo import LogLevelEnum +options = { + 'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key + 'account_id': '123456', # VWO Account ID + 'logger': { + 'level': LogLevelEnum.DEBUG, + 'prefix': 'VWO-FME-PYTHON-SDK' + } +} + +vwo_client = init(options) +``` + +- **Polling support** + +```python +options = { + 'sdk_key': '32-alpha-numeric-sdk-key', # SDK Key + 'account_id': '123456', # VWO Account ID + 'poll_interval': 5000 # in milliseconds +} + +vwo_client = init(options) +``` + +## Local development + +```bash +python setup.py develop +``` + +## Running Unit Tests + +```bash +python setup.py test +``` + +## Authors + +* [Abhishek Joshi](https://github.com/Abhi591) + +## Changelog + +Refer [CHANGELOG.md](https://github.com/wingify/vwo-fme-python-sdk/blob/master/CHANGELOG.md) + +## Contributing + +Please go through our [contributing guidelines](https://github.com/wingify/vwo-fme-python-sdk/blob/master/CONTRIBUTING.md) + + +## Code of Conduct + +[Code of Conduct](https://github.com/wingify/vwo-fme-python-sdk/blob/master/CODE_OF_CONDUCT.md) + +## License + +[Apache License, Version 2.0](https://github.com/wingify/vwo-fme-python-sdk/blob/master/LICENSE) + +Copyright 2024 Wingify Software Pvt. Ltd.