Skip to main content

Python bindings for the Nylas API platform.

Project description

Aimeos logo

Nylas Python SDK

PyPI - Version codecov

This is the GitHub repository for the Nylas Python SDK. The repo is primarily for anyone who wants to install the SDK from source or make contributions to it.

If you're looking to use Python to access the Nylas Email, Calendar, or Contacts APIs, see our Python SDK Quickstart guide.

The Nylas platform provides REST APIs for Email, Calendar, and Contacts, and the Python SDK is the quickest way to build your integration using Python.

Here are some resources to help you get started:

If you have any questions about the Nylas platform, please reach out to support@nylas.com.

⚙️ Install

The Nylas Python SDK is available via pip:

pip install nylas --pre

To install the SDK from source, clone this repo and run the install script:

git clone https://github.com/nylas/nylas-python.git && cd nylas-python
python setup.py install

⚡️ Usage

Before you use the Nylas Python SDK, you must first create a Nylas account. Then, follow our API v3 Quickstart guide to set up your first app and get your API keys.

For code samples and example applications, take a look at our Python repos in the Nylas Samples collection.

🚀 Make your first request

After you've installed and set up the Nylas Python SDK, you can make your first API request. To do so, use the Client class from the nylas package.

The SDK is organized into different resources, each of which has methods to make requests to the Nylas API. Each resource is available through the Client object that you configured with your API key. For example, you can use this code to get a list of Calendars:

from nylas import Client

nylas = Client(
    api_key="API_KEY",
)

calendars = nylas.calendars.list("GRANT_ID")

📚 Documentation

Nylas maintains a reference guide for the Python SDK to help you get familiar with the available functions and classes.

✨ Upgrade from v5.x

See UPGRADE.md for instructions on upgrading from v5.x to v6.x.

💙 Contribute

Please refer to Contributing for information about how to make contributions to this project. We welcome questions, bug reports, and pull requests.

📝 License

This project is licensed under the terms of the MIT license. Please refer to LICENSE for the full terms.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nylas-6.0.0b3.tar.gz (24.6 kB view details)

Uploaded Source

File details

Details for the file nylas-6.0.0b3.tar.gz.

File metadata

  • Download URL: nylas-6.0.0b3.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.18

File hashes

Hashes for nylas-6.0.0b3.tar.gz
Algorithm Hash digest
SHA256 030e9322146ab9ec2fa265d0e3a4b6b7f0c1b79e91c709c5ad1e6ef6cf811361
MD5 08b63a2241cfc01ddbb1866c63773e9c
BLAKE2b-256 6262fd48ee571b55de1bd51d9788a36956e03c682b27f7b5e3c905ca5a39f67f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page