Skip to main content

A static code analyzer that provides automated quality control for Dialogflow CX Agents

Project description

Dialogflow CX Linter


Similar to code linting, Dialogflow CX Agents can benefit from an automated linter to catch various common design defects when developing Agents. The primary goal is to minimize common defects shipped to production by proactively catching and fixing them.

Quick Start

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Setup Authentication.

Mac/Linux

pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-dialogflow-cx

Windows


pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-dialogflow-cx

Authentication

Authentication can vary depending on how and where you are interacting with Dialogfow CX Linter.

Google Colab

If you're using cxlint with a Google Colab notebook, you can add the following to the top of your notebook for easy authentication

project_id = '<YOUR_GCP_PROJECT_ID>'

# this will launch an interactive prompt that allows you to auth with GCP in a browser
!gcloud auth application-default login --no-launch-browser

# this will set your active project to the `project_id` above
!gcloud auth application-default set-quota-project $project_id

After running the above, Colab will pick up your credentials from the environment. No need to use Service Account keys!

Rules

Curent list of rules that are being implemented for CX Linter.
If you have an idea for a new rule, please submit a Feature Request!

Examples

Code samples and snippets live in the examples/ folder.

Supported Python Versions

Python >= 3.8

Contributing

We welcome any contributions or feature requests you would like to submit!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Project details


Download files

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

Source Distribution

cxlint-1.0.4.tar.gz (136.2 kB view details)

Uploaded Source

Built Distribution

cxlint-1.0.4-py3-none-any.whl (53.0 kB view details)

Uploaded Python 3

File details

Details for the file cxlint-1.0.4.tar.gz.

File metadata

  • Download URL: cxlint-1.0.4.tar.gz
  • Upload date:
  • Size: 136.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.6.8

File hashes

Hashes for cxlint-1.0.4.tar.gz
Algorithm Hash digest
SHA256 53ce45dd3424f814b1fc4495ea7a369cc135f5075e294958737797fd46d27166
MD5 cb3a92b2ee226187387a02da64611adc
BLAKE2b-256 21888d6d6a771ee314ff28ed480209905162afe150f61a8fa79ef0f8a890a91e

See more details on using hashes here.

File details

Details for the file cxlint-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: cxlint-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 53.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.6.8

File hashes

Hashes for cxlint-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4a398ac3c2e72d8d7c152568fd5754db587d9e4b039db5def4d8c99ce318a860
MD5 685ed147281234f1135586c838df243c
BLAKE2b-256 9ed5b3d1f27afddc935858c8fc568d4d7d44cf48e059b2888b9c75006c6f6c06

See more details on using hashes here.

Supported by

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