Skip to main content

CLI toolkit for managing Circle.so communities at scale

Project description

circle-so

CLI toolkit for managing Circle.so communities at scale.

Built on top of circle-so-python-sdk.

Installation

pip install circle-so

Quick Start

export CIRCLE_API_TOKEN="your_token"

# Spaces
circle-so spaces list --prefix kcna
circle-so spaces search "KCNA 048"
circle-so spaces lock --prefix kcna
circle-so spaces rename 1761784 --name "KCNA 072" --slug "kcna-072"

# Members
circle-so members import learners.csv
circle-so members audit --prefix kcna --cache
circle-so members add learners.csv --space "KCNA 048"
circle-so members fix-missing --dry-run
circle-so members move --from "KCNA 046" --to "KCNA 073" --max 100

# Moderators
circle-so moderators verify moderators.csv
circle-so moderators add moderators.csv

# Reports
circle-so report counts --prefix kcna
circle-so report inactive
circle-so report missing
circle-so report export moves

Configuration

Set via environment variables or .env file:

CIRCLE_API_TOKEN=your_token
CIRCLE_COMMUNITY_URL=https://your-community.circle.so
CIRCLE_SO_DB=./circle-so.db
CIRCLE_SO_DATA_DIR=~/Documents/Andela-K8s

License

MIT

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

circle_so_cli-0.1.0.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

circle_so_cli-0.1.0-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file circle_so_cli-0.1.0.tar.gz.

File metadata

  • Download URL: circle_so_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for circle_so_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7b146d9f89141a881ee23c584b1f066f9617dc1ec07f6851f6829ac1d121ff87
MD5 7893f9ffefc8d665b53d9200ef5138b7
BLAKE2b-256 4188ce16e60408f5eacdda566d1df438346d2526ce1178809b09805b6db71e2d

See more details on using hashes here.

File details

Details for the file circle_so_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: circle_so_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for circle_so_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 401d33d59095022fdc5dcfb6629eb7443f3877fcb09d9edf54a250423fca406b
MD5 c179fb88754a7243d045705786cbe4ef
BLAKE2b-256 4e7943f7f8ac9fda2b4c487538af73dbd0cf6e06bb407df47ddc7c41ff1026c5

See more details on using hashes here.

Supported by

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