Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robnewman/cannyio-revenue
Python script
https://github.com/robnewman/cannyio-revenue
Last synced: about 1 month ago
JSON representation
Python script
- Host: GitHub
- URL: https://github.com/robnewman/cannyio-revenue
- Owner: robnewman
- License: mit
- Created: 2024-06-18T15:11:21.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-21T13:26:14.000Z (5 months ago)
- Last Synced: 2024-06-22T16:24:08.638Z (5 months ago)
- Language: Python
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cannyio-revenue
Utility to query the Canny Companies API endpoint and return all companies,
update the company MRR value, then send a Slack notification with
the list of companies and their associated MRR.
## Overview
Simple Python script to query the [Canny.io API Companies
endpoint](https://developers.canny.io/api-reference#companies) and
return all companies. The Sales team provide a Hubspot report for all companies
that lists the ARR, which needs to be parsed, cross-referenced with the
company name, and the company MRR (or `monthlySpend` key:value) updated
in Canny. This helps the Product team to prioritize feature requests.
The following environment variables are stored in a `.env` file and not part of this repository:
- Canny API key
- Slack OAuth token
- Slack channel name
- Total users
The `.env` file contents (in same directory as Python script):
```sh
API_KEY=
SLACKBOT_OAUTH_TOKEN=
SLACK_CHANNEL=
TOTAL_COMPANIES=
REVENUE_FILE=
REQUIRED_FIELDS=
```
## Assumptions
- The Canny Companies API endpoint allows a maximum of 100 records returned (you can optionally define a `skip` value to skip N records).
- The Python script currently naively assumes a maximum of `TOTAL_COMPANIES` and iterates in blocks of 100.
- There is a working Slackbot integration with the auth token stored in the `.env` file
## Virtual environment
This script uses a virtual environment called `cannyio-revenue`. Use Conda
to recreate the environment on your localhost:
```
conda env create -f environment.yml
```
Make sure to activate the environment before running the script:
```
conda activate cannyio-revenue
```
## Run the script
Execute the script with the following Python command:
```
$ python add-revenue.py
```
- Companies that don't have revenue attached will return a 400 Bad Request because the MRR is NaN
- Companies that are not in the revenue file will be returned as a list of missing companies