Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 2.07 KB

README.md

File metadata and controls

61 lines (43 loc) · 2.07 KB
Raw

Zucker

Tests and style linting

Zucker is a Python library for Sugar CRM with a simple, readable API. Features:

  • No dependencies (except for an HTTP client of your choice)
  • Native support for both synchronous and asyncio paradigms
  • Schema introspection that extracts supported fields from a Sugar server to speed up development
  • ORM-like feel that abstracts away details of the upstream API
  • Fully type-checked (internal and external code)

To get started, have a look at the Documentation. If you find that something is missing, feel free to open an issue.

What does it look like?

First, connect to a Sugar server. Then you can define a model that matches what you have on the backend (use the introspection features to speed up this process!):

from zucker import model, RequestsClient

crm = RequestsClient("https://crm.example.com", "zucker", "password")

class Contact(model.SyncModule, client=crm, api_name="Contacts"):
    lead_source = model.StringField()
    phone_work = model.StringField()


contacts = Contact.find(Contact.lead_source == "Word of mouth")
for contact in contacts:
    print(contact.phone_work)
print(",".join(contact.phone_work for contact in contacts[:3]))

Again, see the Documentation for more examples.

Introspection

Zucker also supports introspecting a server, which will list the available modules and fields. Use it like this:

$ python -m zucker.codegen -b "https://crm.example.com" -u "username" -c "my_client" -P inspect

See python -m zucker.codegen --help for detailed usage information.

License

MIT