Merge pull request #1 from gray-adeyi/v0.2.0

V0.2.0

Author: gray-adeyi

.github/FUNDING.yml

@@ -0,0 +1 @@
+buy_me_a_coffee: jigani

.gitignore

@@ -1,4 +1,5 @@
 *.pyc
 .idea/
 build/
-dist/
+dist/
+paystack.spec

.python-version

@@ -1 +1 @@
-3.11.1
+3.12.2

CHANGELOG.md

@@ -0,0 +1,73 @@
+# 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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - May 11, 2024
+
+### Fixed
+
+- All request errors exits gracefully with exit code 1.
+
+### Changed
+
+- `--data-only` flag of all sub-commands now return json data
+- Upgrade `pypaystack2` to `2.0.3`
+- Upgrade `typer` to `0.12.3`
+- Switched from poetry to rye
+
+## [0.1.4] - Dec 1, 2023
+
+### Fixed
+
+- Incorrect project versioning
+
+## [0.1.3] - Jul 29, 2023
+
+### Fixed
+
+- Incorrect binary link
+
+## [0.1.2] - Jul 26, 2023
+
+### Fixed
+
+- Missing options for `paystack misc get-providers` sub-command
+- Missing options for `paystack misc get-banks` sub-command
+- Missing options for `paystack misc get-states` sub-command
+- Missing options for `paystack transfer-ctrl resend-otp` sub-command
+
+## [0.1.1] - Jul 24, 2023
+
+### Added
+
+- License to project
+- Source code link to README
+
+### Changed
+
+- Binary download link
+
+## [0.1.0] - Jul 24, 2023
+
+### Added
+
+- Commands and sub-commands for all methods supported by `pypaystack2`
+
+[unreleased]: https://github.com/gray-adeyi/paystack-cli/compare/v0.1.4...HEAD
+
+[0.2.0]: https://github.com/gray-adeyi/paystack-cli/compare/v0.1.4...v0.2.0
+
+[0.1.4]: https://github.com/gray-adeyi/paystack-cli/compare/0.1.3...v0.1.4
+
+[0.1.3]: https://github.com/gray-adeyi/paystack-cli/compare/0.1.2...0.1.3
+
+[0.1.2]: https://github.com/gray-adeyi/paystack-cli/compare/0.1.1...0.1.2
+
+[0.1.1]: https://github.com/gray-adeyi/paystack-cli/compare/0.1.0...0.1.1
+
+[0.1.0]: https://github.com/gray-adeyi/paystack-cli/releases/tag/0.1.0

Makefile

@@ -1,3 +1,3 @@
 build-linux:
 	echo "building for linux..."
-	pyinstaller --onefile paystack_cli/main.py --name paystack
+	pyinstaller --onefile src/paystack_cli/__main__.py --name paystack

README.md

@@ -3,11 +3,11 @@
 A command line app for interacting with [Paystack's](https://paystack.com/) API. Built with
 [Typer](https://typer.tiangolo.com/) and [Pypaystack2](https://gray-adeyi.github.io/pypaystack2/)
 
-![utility in use](./paystack-cli.png)
+![a picture of the utility in use](./paystack-cli.png)
 
 ## Installation
 
-Binaries of paystack cli be found [here](https://github.com/gray-adeyi/paystack-cli/releases/tag/v0.1.4).
+Binaries of paystack cli be found [here](https://github.com/gray-adeyi/paystack-cli/releases/tag/v0.2.0).
 Alternatively, Paystack cli can be installed from pypi with pip as shown below.
 
 ```bash
@@ -16,7 +16,7 @@ pip install paystack-cli
 
 ## First time configurations
 
-You're required to add your paystack auth_key on first use as shown below
+You're required to add your paystack integration secret key as your auth_key for the cli on first use as shown below
 
 ```bash
 paystack config AUTH_KEY
@@ -25,6 +25,88 @@ paystack config AUTH_KEY
 This sets up your paystack cli for use in development mode if the test secret key is used. This auth_key can be
 removed with `paystack reset`. Run `paystack --help` to see available commands
 
+## Examples
+
+### Retrieve a single transaction from your integration
+
+```bash
+paystack txn get-txns --pagination 1
+```
+
+Running the command above should yield a result similar to the dump shown below
+
+```bash
+Response(
+    status_code=200,
+    status=True,
+    message='Transactions retrieved',
+    data=[
+        {
+            'id': 3785557723,
+            'domain': 'test',
+            'status': 'success',
+            'reference': '2769088ddc23d52947c8e845f6a6bbdebd987f457e97f71c',
+            'amount': 30000,
+            'message': None,
+            'gateway_response': 'Approved',
+            'paid_at': '2024-05-11T10:00:29.000Z',
+            'created_at': '2024-05-11T10:00:27.000Z',
+            'channel': 'card',
+            'currency': 'NGN',
+            'ip_address': None,
+            'metadata': {'invoice_action': 'create'},
+            'log': None,
+            'fees': 450,
+            'fees_split': None,
+            'customer': {'id': 47948280, 'first_name': 'Gbenga', 'last_name': 'Adeyi', 'email': 'coyotedevmail@gmail.com', 'phone': '', 'metadata': None, 'customer_code': 'CUS_73cb3biedlkbe4a', 'risk_action': 'default'},
+            'authorization': {
+                'authorization_code': 'AUTH_w1renosr9o',
+                'bin': '408408',
+                'last4': '4081',
+                'exp_month': '12',
+                'exp_year': '2030',
+                'channel': 'card',
+                'card_type': 'visa ',
+                'bank': 'TEST BANK',
+                'country_code': 'NG',
+                'brand': 'visa',
+                'reusable': True,
+                'signature': 'SIG_JOdryeujwrsZryg0Lkrg',
+                'account_name': None
+            },
+            'plan': {},
+            'split': {},
+            'subaccount': {},
+            'order_id': None,
+            'paidAt': '2024-05-11T10:00:29.000Z',
+            'createdAt': '2024-05-11T10:00:27.000Z',
+            'requested_amount': 30000,
+            'source': {'source': 'merchant_api', 'type': 'api', 'identifier': None, 'entry_point': 'charge'},
+            'connect': None,
+            'pos_transaction_data': None
+        }
+    ]
+)
+```
+
+By default, the results you get from the cli is a `Response` object which is a `NamedTuple` returned
+by [Pypaystack2](https://gray-adeyi.github.io/pypaystack2/). To get a json result, use the `--data-only`
+flag.
+
+```bash
+paystack txn get-txns --pagination 1 --data-only
+```
+
+Running the command above should yield a result similar to the dump shown below
+
+```bash
+[{"id": 3785557723, "domain": "test", "status": "success", "reference": "2769088ddc23d52947c8e845f6a6bbdebd987f457e97f71c", "amount": 30000, "message": null, "gateway_response": "Approved", "paid_at": "2024-05-11T10:00:29.000Z", "created_at": 
+"2024-05-11T10:00:27.000Z", "channel": "card", "currency": "NGN", "ip_address": null, "metadata": {"invoice_action": "create"}, "log": null, "fees": 450, "fees_split": null, "customer": {"id": 47948280, "first_name": "John", "last_name": "Doe", "email": 
+"johndoe@example.com", "phone": "", "metadata": null, "customer_code": "CUS_73cb3biedlkbe4a", "risk_action": "default"}, "authorization": {"authorization_code": "AUTH_w1renosr9o", "bin": "408408", "last4": "4081", "exp_month": "12", "exp_year": "2030", 
+"channel": "card", "card_type": "visa ", "bank": "TEST BANK", "country_code": "NG", "brand": "visa", "reusable": true, "signature": "SIG_JOdryeujwrsZryg0Lkrg", "account_name": null}, "plan": {}, "split": {}, "subaccount": {}, "order_id": null, "paidAt": 
+"2024-05-11T10:00:29.000Z", "createdAt": "2024-05-11T10:00:27.000Z", "requested_amount": 30000, "source": {"source": "merchant_api", "type": "api", "identifier": null, "entry_point": "charge"}, "connect": null, "pos_transaction_data": null}]
+```
+
 ## Source code
 
 [https://github.com/gray-adeyi/paystack-cli](https://github.com/gray-adeyi/paystack-cli)