Metadata-Version: 2.4
Name: circle-so-cli
Version: 0.1.0
Summary: CLI toolkit for managing Circle.so communities at scale
Project-URL: Homepage, https://github.com/boiyelove/circle-so
Project-URL: Repository, https://github.com/boiyelove/circle-so
Author: Damilola Afolabi
License-Expression: MIT
License-File: LICENSE
Keywords: circle,circle.so,cli,community,management
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Typing :: Typed
Requires-Python: >=3.9
Requires-Dist: circle-so-python-sdk>=0.1.0
Requires-Dist: click>=8.0
Requires-Dist: python-dotenv>=1.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Description-Content-Type: text/markdown

# circle-so

CLI toolkit for managing Circle.so communities at scale.

Built on top of [circle-so-python-sdk](https://github.com/boiyelove/circle-so-python-sdk).

## Installation

```bash
pip install circle-so
```

## Quick Start

```bash
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:

```bash
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
