Simple Frappe-like Python wrapper for Frappe REST API
git clone https://github.com/frappe/frappe-client
pip install -e frappe-client
FrappeClient has a frappe like API
Login to the Frappe HTTP Server by creating a new FrappeClient object
from frappeclient import FrappeClient
conn = FrappeClient("example.com")
conn.login("[email protected]", "password")from frappeclient import FrappeClient
client = FrappeClient("https://example.com")
client.authenticate("my_api_key", "my_api_secret")For demonstration purposes only! Never store any credentials in your source code. Instead, you could set them as environment variables and fetch them with os.getenv().
Get a list of documents from the server
Arguments:
doctypefields: List of fields to fetchfilters: Dict of filterslimit_start: Start at row ID (default 0)limit_page_length: Page lengthorder_by: sort key and order (default ismodified desc)
users = conn.get_list('User', fields = ['name', 'first_name', 'last_name'], , filters = {'user_type':'System User'})Example of filters:
{ "user_type": ("!=", "System User") }{ "creation": (">", "2020-01-01") }{ "name": "[email protected]" }
Insert a new document to the server
Arguments:
doc: Document object
doc = conn.insert({
"doctype": "Customer",
"customer_name": "Example Co",
"customer_type": "Company",
"website": "example.net"
})Fetch a document from the server
Arguments
doctypename
doc = conn.get_doc('Customer', 'Example Co')Fetch a single value from the server
Arguments:
doctypefieldnamefilters
customer_name = conn.get_value("Customer", "name", {"website": "example.net"})Update a document (if permitted)
Arguments:
doc: JSON document object
doc = conn.get_doc('Customer', 'Example Co')
doc['phone'] = '000000000'
conn.update(doc)Delete a document (if permitted)
Arguments:
doctypename
conn.delete('Customer', 'Example Co')from frappeclient import FrappeClient
conn = FrappeClient("example.com", "[email protected]", "password")
new_notes = [
{"doctype": "Note", "title": "Sing", "public": True},
{"doctype": "Note", "title": "a", "public": True},
{"doctype": "Note", "title": "Song", "public": True},
{"doctype": "Note", "title": "of", "public": True},
{"doctype": "Note", "title": "sixpence", "public": True}
]
for note in new_notes:
print(conn.insert(note))
# get note starting with s
notes = conn.get_list('Note',
filters={'title': ('like', 's')},
fields=["title", "public"]
)See example.py for more info
MIT
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent