You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!--- The following is a checklist of items that MUST be completed before a PR is accepted -->
31
-
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
32
-
-[ ] My code follows the code style of this project.
33
-
-[ ] I have read the **CONTRIBUTING**[document](https://github.com/QuantConnect/Lean/blob/master/CONTRIBUTING.md).
34
-
-[ ] I have added tests to cover my changes. <!--- If not applicable, please explain why -->
35
-
-[ ] All new and existing tests passed.
36
-
-[ ] My branch follows the naming convention `bug-<issue#>-<description>` or `feature-<issue#>-<description>`
37
-
38
-
39
-
@Flutterwave/Corvus97 What do you think about these updates?
1
+
### Requirements for contributing to the library
2
+
3
+
* Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
4
+
* Include the issue link for bug fixes.
5
+
* The pull request must include a test suite to demonstrate the changed functionality.
6
+
* After you create the pull request, all status checks must pass before a maintainer reviews your contribution.
7
+
8
+
### Type of change
9
+
[] Bug fix
10
+
[] Performance improvement
11
+
[] Documentation update
12
+
13
+
### Description of the change
14
+
15
+
<!--
16
+
17
+
We should understand the purpose of your change from this description. We would not review PRs with inadequate descriptions.
18
+
19
+
-->
20
+
21
+
22
+
### Related issue
23
+
24
+
<!--
25
+
26
+
Link to the issue that your change relates to. For feature requests, send us an email at developers@flutterwavego.com
27
+
28
+
-->
29
+
30
+
31
+
### Checklist
32
+
33
+
[] I have read the contribution document.
34
+
[] I have added tests to cover my changes.
35
+
[] All new and existing tests passed.
36
+
37
+
38
+
### Release Notes
39
+
40
+
<!--
41
+
42
+
Please describe the changes in a single line that explains this improvement in
43
+
a user-friendly manner. This text will be used in our release notes.
44
+
45
+
If said change is not user-facing or notable enough to be included in release notes
46
+
you may use "N/A" here.
47
+
48
+
Examples:
49
+
50
+
- The GitHub package now allows you to charge XAF payments.
51
+
- Fixed an issue where payment plan creation returns an error.
52
+
- Increased the performance of searching paginated responses.
Thank you for taking the time to contribute to our library🙌🏾.
2
+
3
+
In this section, we detail everything you need to know about contributing to this library.
4
+
5
+
6
+
**[Code of Conduct](https://github.com/probot/template/blob/master/CODE_OF_CONDUCT.md)**
7
+
8
+
## **I don't want to contribute, I have a question**
9
+
10
+
Please don't raise an issue to ask a question. You can ask questions on our [forum](http://forum.flutterwave.com) or developer [slack](https://bit.ly/34Vkzcg). We have an army of Engineers on hand to answer your questions there.
11
+
12
+
## How can I contribute?
13
+
14
+
### Reporting a bug
15
+
16
+
Have you spotted a bug? Fantastic! Before raising an issue, here are some things to do:
17
+
18
+
1. Search to see if another user has reported the bug. For existing issues that are still open, add a comment instead of creating a new one.
19
+
2. Check our forum and developer slack to confirm that we did not address it there.
20
+
21
+
When you report an issue, it is important to:
22
+
23
+
1. Explain the problem
24
+
- Use a clear and descriptive title to help us to identify the problem.
25
+
- Describe steps we can use to replicate the bug and be as precise as possible.
26
+
- Include screenshots of the error messages.
27
+
2. Include details about your configuration and setup
28
+
- What version of the library are you using?
29
+
- Did you experience the bug on test mode or live?
30
+
- Do you have the recommended versions of the library dependencies?
31
+
32
+
<aside>
33
+
34
+
💡 Please make use of the issue template when reporting bugs.
35
+
36
+
</aside>
37
+
38
+
### Requesting a feature
39
+
40
+
If you need an additional feature added to the library, kindly send us an email at developers@flutterwavego.com. Be sure to include the following in your request:
41
+
42
+
1. A clear title that helps us to identify the requested feature.
43
+
2. A brief description of the use case for that feature.
44
+
3. Explain how this feature would be helpful to your integration.
45
+
4. Library name and version.
46
+
47
+
### Submitting changes (PR)
48
+
49
+
Generally, you can make any of the following changes to the library:
50
+
51
+
1. Bug fixes
52
+
2. Performance improvement
53
+
3. Documentation update
54
+
4. Functionality change (usually new features)
55
+
56
+
<aside>
57
+
58
+
💡 Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of the library will generally not be accepted.
59
+
60
+
</aside>
61
+
62
+
Follow these steps when making a pull request to the library:
63
+
64
+
1. Fork the repository and create your branch from master.
65
+
2. For all types of changes (excluding documentation updates), add tests for the changes.
66
+
3. If you are making a functionality change, update the docs to show how to use the new feature.
67
+
4. Ensure all your tests pass.
68
+
5. Make sure your code lints.
69
+
6. Write clear log messages for your commits. one-liners are fine for small changes, but bigger changes should have a more descriptive commit message (see sample below).
70
+
7. Use present tense for commit messages, "Add feature" not "Added feature”.
71
+
8. Ensure that you fill out all sections of the PR template.
72
+
9. Raise the PR against the `staging` branch.
73
+
10. After you submit the PR, verify that all [status checks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks) are passing
74
+
75
+
```markdown
76
+
$ git commit -m "A brief summary of the commit
77
+
>
78
+
> A paragraph describing what changed and its impact."
79
+
```
80
+
81
+
<aside>
82
+
83
+
💡 For your pull request to be reviewed, you need to meet the requirements above. We may ask you to complete additional tests, or other changes before your pull request can be ultimately accepted.
84
+
85
+
</aside>
86
+
87
+
We encourage you to contribute and help make the library better for the community. Got questions? send us a [message](https://bit.ly/34Vkzcg).
Copy file name to clipboardExpand all lines: README.md
+63-32Lines changed: 63 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,49 +10,56 @@
10
10
11
11
12
12
## Introduction
13
-
This is a Python wrapper around the [API](https://flutterwavedevelopers.readme.io/v2.0/reference) for [Rave by Flutterwave](https://rave.flutterwave.com).
14
-
15
-
#### Payment types implemented:
16
-
* Card Payments
17
-
* Bank Account Payments
18
-
* Ghana Mobile Money Payments
19
-
* Mpesa Payments
20
-
* Rwanda Mobile Money Payments
21
-
* Uganda Mobile Money Payments
22
-
* Zambia Mobile Money Payments
23
-
* Mobile Money Payments for Francophone countries
24
-
* Subaccounts
25
-
* Transfer
26
-
* Subscription (Recurring Payments)
27
-
* Bills payment
28
-
* Payment Plan
29
-
* USSD Payments (Still in Beta Mode)
30
-
31
-
#### Other features include:
32
-
* Preauthorization charges
33
-
* Refunds
34
-
* Transaction Verification
35
-
* Transfer Recipients
36
-
* Virtual Cards
37
-
* Virtual Accounts
13
+
The Python library provides easy access to Flutterwave for Business (F4B) v2 APIs from Django, Flask, and other Python apps. It abstracts the complexity involved in direct integration and allows you to make quick calls to the APIs.
14
+
15
+
Available features include:
16
+
17
+
- Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter, NQR.
18
+
- Payouts and Beneficiaries.
19
+
- Recurring payments: Tokenization and Subscriptions.
20
+
- Split payments
21
+
- Card issuing
22
+
- Transactions dispute management: Refunds.
23
+
- Transaction reporting: Collections, Payouts, Settlements, and Refunds.
24
+
- Bill payments: Airtime, Data bundle, Cable, Power, Toll, E-bills, and Remitta.
25
+
- Identity verification: Resolve bank account, resolve BVN information.
26
+
27
+
## Table of Contents
28
+
1.[Requirements](#requirements)
29
+
2.[Installation](#installation)
30
+
3.[Initialization](#initialization)
31
+
4.[Usage](#usage)
32
+
5.[Testing](#testing)
33
+
6.[Debugging Errors](#debugging-errors)
34
+
7.[Support](#support)
35
+
8.[Contribution guidelines](#)
36
+
9.[License](#)
37
+
10.[Changelog](#)
38
+
39
+
## Requirements
40
+
1. Flutterwave for business [API Keys](https://developer.flutterwave.com/docs/integration-guides/authentication)
The base class for this package is 'Rave'. To use this class, add:
49
58
50
59
```py
51
60
from rave_python import Rave
52
61
```
53
62
54
-
## Initialization
55
-
56
63
#### To instantiate in sandbox:
57
64
To use Rave, instantiate the Rave class with your public key. We recommend that you store your secret key in an environment variable named, ```RAVE_SECRET_KEY```. Instantiating your rave object is therefore as simple as:
58
65
@@ -75,7 +82,9 @@ To initialize in production, simply set the ```production``` flag to ```True```.
75
82
rave = Rave("YOUR_PUBLIC_KEY", production=True)
76
83
```
77
84
78
-
# Rave Objects
85
+
86
+
87
+
# Usage
79
88
This is the documentation for all of the components of rave_python
80
89
81
90
## ```rave.Card```
@@ -2775,7 +2784,8 @@ This call returns a dictionary. A sample response is:
2775
2784
```
2776
2785
<br>
2777
2786
2778
-
## Run Tests
2787
+
2788
+
## Testing
2779
2789
2780
2790
All of the SDK's tests are written with Python's ```unittest``` module. The tests currently test:
2781
2791
```rave.Account```
@@ -2797,5 +2807,26 @@ python test.py
2797
2807
>**NOTE:** The test may fail for account validation -``` Pending OTP validation``` depending on whether the service is down ornot
2798
2808
<br>
2799
2809
2810
+
2811
+
## Debugging Errors
2812
+
We understand that you may run into some errors while integrating our library. You can read more about our error messages [here](https://developer.flutterwave.com/docs/integration-guides/errors).
2813
+
2814
+
For `authorization`and`validation` error responses, double-check your API keys and request. If you get a `server` error, kindly engage the team for support.
2815
+
2816
+
2817
+
2800
2818
## Support
2801
-
For further assistance in using the SDK, you can contact the Developers on [Slack](https://join.slack.com/t/flutterwavedevelopers/shared_invite/enQtNTk3MjgxMjU3ODI5LWFkMjBkYTc0ZGJhM2Q5MTY3YjFkYzAyYmM1ZDZjZjUwMjE4YTc2NjQ1ZGM5ZWE4NDUxMzc4MmExYmI1Yjg5ZWU) and [Email](mailto:developers@flutterwavego.com). You can get more information about the amazing features here [here](https://developer.flutterwave.com/reference#introduction).
2819
+
For additional assistance using this library, contact the developer experience (DX) team via [email](mailto:developers@flutterwavego.com) or on [slack](https://bit.ly/34Vkzcg).
2820
+
2821
+
You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊.
2822
+
2823
+
2824
+
## Contribution guidelines
2825
+
Read more about our community contribution guidelines [here](/CONTRIBUTING.md)
2826
+
2827
+
2828
+
## License
2829
+
2830
+
By contributing to this library, you agree that your contributions will be licensed under its [MITlicense](/LICENSE).
0 commit comments