Skip to content

Commit

Permalink
Merge pull request #1 from flick-network/aiohttp
Browse files Browse the repository at this point in the history 
Aiohttp
  • Loading branch information
@sivadasrajan
sivadasrajan authored Oct 16, 2023
2 parents cbe571f + 4e8a6f3 commit ce5e788
Show file tree
Hide file tree
Showing 8 changed files with 816 additions and 2 deletions.
210 changes: 208 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,208 @@
# flick-python-sdk
Flick's API SDK for Python
# Flick Python SDK
![Platform](https://img.shields.io/badge/python-3-blue)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE.md)


A python interface for interacting with the APIs of Flick.

- [Installation](#installation)
- [Getting Started](#getting-started)
- [Documentation](#documentation)
- [Examples](#examples)
- [Contribute to our SDK](#contributing)
- [License](#license)
- [Support](#support)

## Installation
To use the Flick Python SDK in your project, you can install it via pip:

```bash
pip install flick-python-sdk
```

## Getting Started
Before using the package, you need to configure it with your API credentials. You should have an apiKey and specify whether you are using the 'sandbox' or 'production' environment.

Here's how you to initiate our SDK in your project:

```python
import asyncio
from flick import Config
from bills import Bills

config = Config('sandbox', 'your-api-key')
api = Bills(config=config)
```

## Documentation
To learn about available methods and their usage, please refer to the [official API documentation](https://docs.flick.network/).
Here's a glimpse to our Bills Module:

### Bills Client
The Bills client provides access to various functionalities for managing bills. You can interact with the following API endpoints:

#### Onboard EGS to ZATCA:

```python
egs_data = { /* Your EGS data - Check Documentation */ }
loop = asyncio.get_event_loop()
result = loop.run_until_complete(api.onboard_egs(egs_data=egs_data))
```

#### Compliance Check:

```python
egs_uuid = 'your-egs-uuid';
loop = asyncio.get_event_loop()
result = loop.run_until_complete(api.do_compliance_check(egs_uuid))
```

#### Generate E-Invoice for Phase-2 in Saudi Arabia:
```python
invoiceData = { /* Your invoice data - Check Documentation */ }
loop = asyncio.get_event_loop()
result = loop.run_until_complete(api.generate_invoice(invoiceData))
```

## Examples

1. Here's an Example of how you can **onboard multiple EGS to ZATCA Portal** [If you are onboarding PoS devices or VAT-Group members, this comes handy].

```python
import asyncio
from flick.api_service import Config
from flick.bills import Bills,EGSData,Devices

config = Config('sandbox', 'your-api-key')

client = Bills(config)

egs_data = EGSData(
vat_name='Test Co.',
vat_number='300000000000003',
devices=[
Devices(
device_name='TestEGS1',
city='Riyadh',
city_subdiv='Test Dist.',
street='Test St.',
plot='1234',
building='1234',
postal='12345',
# This will be 10-digit TIN if you are onboarding a VAT-Group Member
branch_name='Riyad Branc h 1',
branch_industry='Retail',
otp='123321',
), Devices(
device_name='TestEGS2',
city='Riyadh',
city_subdiv='Test Dist.',
street='Test St.',
plot='1234',
building='1234',
postal='12345',
# This will be 10-digit TIN if you are onboarding a VAT-Group Member
branch_name='Riyad Branch 1',
branch_industry='Retail',
otp='123321',
),
]
)


loop = asyncio.get_event_loop()
result = loop.run_until_complete(client.onboard_egs(egs_data=egs_data))
# Process the result the way you want
print(result)

```

2. Here's an Example of how you can **Genereate a ZATCA-Complied E-Invoice**.

```python
import asyncio
from flick.api_service import Config
from flick.bills import Bills, InvoiceData, PartyAddId, PartyDetails, AdvanceDetails, AdvanceInvoices, Invoice, LineItems

config = Config('sandbox', 'your-api-key')

client = Bills(config)
invoice_data = InvoiceData(
egs_uuid='7b9cc231-0e14-4bff-938c-4603fe10c4bc',
invoice_ref_number='INV-5',
issue_date='2023-01-01',
issue_time='01=40=40',
party_details=PartyDetails(
party_name_ar='شركة اختبار',
party_vat='300001111100003',
party_add_id=PartyAddId(
crn=45463464
),
city_ar='جدة',
city_subdivision_ar='حي الشرفية',
street_ar='شارع الاختبار',
plot_identification='1234',
building='1234',
postal_zone='12345',
),
doc_type='388',
inv_type='standard',
payment_method=10,
currency='SAR',
total_tax=142.,
has_advance=True,
advance_details=AdvanceDetails(
advance_amount=575,
total_amount=2875,
advance_invoices=[
AdvanceInvoices(
tax_category='S',
tax_percentage=0.15,
taxable_amount=500,
tax_amount=75,
invoices=[
Invoice(
invoice_id='INV-1',
issue_date='2022-12-10',
issue_time='12=28=17',
),
],
),
],
),
lineitems=[
LineItems(
name_ar='متحرك',
quantity=1,
tax_category='S',
tax_exclusive_price=750,
tax_percentage=0.15,
),
LineItems(
name_ar='حاسوب محمول',
quantity=1,
tax_category='S',
tax_exclusive_price=1750,
tax_percentage=0.15,
),
],
)

loop = asyncio.get_event_loop()
result = loop.run_until_complete(client.generate_invoice(invoice_data=invoice_data))
# Process the result the way you want
print(result)

```

## Contributing

We welcome contributions from the community. If you find issues or have suggestions for improvements, please open an issue or create a pull request.

## License

This project is licensed under the MIT License - see the LICENSE file for details.

## Support

If you encounter any issues or have questions, please contact our support team at [email protected]
12 changes: 12 additions & 0 deletions examples/compiance_check.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import asyncio
from flick.api_service import Config
from flick.bills import Bills

config = Config('sandbox', 'your-api-key')

client = Bills(config)

loop = asyncio.get_event_loop()
result = loop.run_until_complete(client.do_compliance_check(egs_uuid="your-egs-uuid-here"))
# Process the result the way you want
print(result)
72 changes: 72 additions & 0 deletions examples/generate_invoice.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
import asyncio
from flick.api_service import Config
from flick.bills import Bills, InvoiceData, PartyAddId, PartyDetails, AdvanceDetails, AdvanceInvoices, Invoice, LineItems

config = Config('sandbox', 'your-api-key')

client = Bills(config)
invoice_data = InvoiceData(
egs_uuid='7b9cc231-0e14-4bff-938c-4603fe10c4bc',
invoice_ref_number='INV-5',
issue_date='2023-01-01',
issue_time='01=40=40',
party_details=PartyDetails(
party_name_ar='شركة اختبار',
party_vat='300001111100003',
party_add_id=PartyAddId(
crn=45463464
),
city_ar='جدة',
city_subdivision_ar='حي الشرفية',
street_ar='شارع الاختبار',
plot_identification='1234',
building='1234',
postal_zone='12345',
),
doc_type='388',
inv_type='standard',
payment_method=10,
currency='SAR',
total_tax=142.,
has_advance=True,
advance_details=AdvanceDetails(
advance_amount=575,
total_amount=2875,
advance_invoices=[
AdvanceInvoices(
tax_category='S',
tax_percentage=0.15,
taxable_amount=500,
tax_amount=75,
invoices=[
Invoice(
invoice_id='INV-1',
issue_date='2022-12-10',
issue_time='12=28=17',
),
],
),
],
),
lineitems=[
LineItems(
name_ar='متحرك',
quantity=1,
tax_category='S',
tax_exclusive_price=750,
tax_percentage=0.15,
),
LineItems(
name_ar='حاسوب محمول',
quantity=1,
tax_category='S',
tax_exclusive_price=1750,
tax_percentage=0.15,
),
],
)

loop = asyncio.get_event_loop()
result = loop.run_until_complete(client.generate_invoice(invoice_data=invoice_data))
# Process the result the way you want
print(result)
46 changes: 46 additions & 0 deletions examples/onboard_egs.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import asyncio
from flick.api_service import Config
from flick.bills import Bills,EGSData,Devices

config = Config('sandbox', 'your-api-key')

client = Bills(config)

egs_data = EGSData(
vat_name='Test Co.',
vat_number='300000000000003',
devices=[
Devices(
device_name='TestEGS1',
city='Riyadh',
city_subdiv='Test Dist.',
street='Test St.',
plot='1234',
building='1234',
postal='12345',
# This will be 10-digit TIN if you are onboarding a VAT-Group Member
branch_name='Riyad Branc h 1',
branch_industry='Retail',
otp='123321',
), Devices(
device_name='TestEGS2',
city='Riyadh',
city_subdiv='Test Dist.',
street='Test St.',
plot='1234',
building='1234',
postal='12345',
# This will be 10-digit TIN if you are onboarding a VAT-Group Member
branch_name='Riyad Branch 1',
branch_industry='Retail',
otp='123321',
),
]
)


loop = asyncio.get_event_loop()
result = loop.run_until_complete(client.onboard_egs(egs_data=egs_data))
# Process the result the way you want
print(result)

26 changes: 26 additions & 0 deletions setup.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
from setuptools import setup
with open("README.md", "r", encoding = "utf-8") as fh:
long_description = fh.read()

setup(
name = "flick-python-sdk",
version = "0.0.14",
author = "Sivadas Rajan",
author_email = "[email protected]",
description = "A Python wrapper for interacting with APIs from Flick.",
long_description = long_description,
long_description_content_type = "text/markdown",
install_requires=["aiohttp>=3.5.0"],
url = "https://pypi.org/project/flick-python-sdk/",
project_urls = {
"Bug Tracker": "https://github.com/flick-network/flick-python-sdk/issues",
},
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
package_dir = {"": "src"},
packages = ['flick'],
python_requires = ">=3.6"
)
2 changes: 2 additions & 0 deletions src/flick/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from .api_service import *
from .bills import *
Loading

0 comments on commit ce5e788

Please sign in to comment.