https://github.com/maximilien/skills-tickets
Automate ticket response for `UserVoice` sites
https://github.com/maximilien/skills-tickets
automation cli python3 uservoice
Last synced: 3 months ago
JSON representation
Automate ticket response for `UserVoice` sites
- Host: GitHub
- URL: https://github.com/maximilien/skills-tickets
- Owner: maximilien
- License: apache-2.0
- Created: 2020-04-30T02:52:00.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-27T03:39:37.000Z (almost 5 years ago)
- Last Synced: 2025-01-04T23:42:34.145Z (5 months ago)
- Topics: automation, cli, python3, uservoice
- Language: Python
- Size: 75.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.adoc
- License: LICENSE
Awesome Lists containing this project
README
# skills-tickets
Automate ticket response for `UserVoice` sites. Using this CLI you can automate generating `suggestions` (or ideas) for open `tickets`. You can also manage `tickets`, `suggestions`, and perform bulk operations.
# Getting started
There are two things you need to get started with the SkillsTickets CLI. From now on called CLI or `st.py`.
First, you need to get a developer or admin account on your `UserVoice` installation. When you do, you will have a series of keys that you need to save and use to use this CLI. The following section named [Credentials](#Credentials) goes into details on how to use these credentials.
Second, you need to setup your [environment](#Environment). See that section for details. However, note that you can either setup your local machine with Python3 and dependencies or better use the `Dockerfile` to create a container with all the details. You can also use one of my publish images: `dockerhub.io/drmax/skillstickets:latest`.
## Credentials
Once you have created credentials for your `UserVoice` account, you will be given the following keys:
1. `subdomain` is the URL subdomain for your `UserVoice` installation, e.g., support.labs.cognitiveclass.ai
2. `url_callback` set this to `http://localhost:4567/`
3. `api_key` this is a unique key for you
4. `api_secret` this is a unique secret key for you
5. `sso_key` this another key you need to generate in your `UserVoice` installation and it perdiodically expires, so you might have to re-generate it
6. `display_name` this is the name that will be used for suggestions and tickets you create with this CLI
7. `email` this is the email you use to login to the `UserVoice` installation
You will need to keep these and use them when invoking the CLI. You can either pass each key with each invokation using the corresponding option named by the key listed above.
Or as a shortcut, you can create a `credentials.yml` file and add all your keys and info in there. Then you can pass all credentials at once using `--credentials=./credentials.yml`.
Create your `./credentials.yml` file with a command as follows or with your favorite editor:
```bash
cat > credentials.yml <