Command-line interface for the Rencom Reviews API
Project description
Rencom - Plug-and-Play E-commerce Reviews API
A modern, scalable API platform for collecting and displaying product reviews for any e-commerce store. No frontend, no platform lock-in—just robust, efficient APIs.
🚀 Features
- API Token Authentication: Secure, token-based access for all endpoints
- Product Reviews: Collect, store, and retrieve reviews for any product
- Pagination & Performance: Designed for scale (1k+ users, 15k+ reviews)
- Supabase Backend: Real-time, scalable PostgreSQL database
- FastAPI: High-performance Python backend
- Docker-Ready: Easy local development and deployment
- CLI Onboarding: Get started instantly with
rencom setup
🛠️ Installation
From PyPI (recommended for most users)
pip install rencom-cli
From Source (for contributors/advanced users)
git clone <repository-url>
cd rencom
pip install .
⚡ Quick Start (API Users)
-
Onboard Instantly
rencom setup- This will guide you through API onboarding and create your API token.
-
Try the API
- Use your token to make requests:
curl -X POST https://rencom-backend.fly.dev/api/v1/reviews \ -H 'Authorization: Bearer <your-token>' \ -H 'Content-Type: application/json' \ -d '{"product_id": "prod-123", "user_id": "user-abc-123", "rating": 5, "comment": "Great!"}'
- Or explore the full API in Postman
-
Shell Completion (Optional)
- Enable tab completion for bash, zsh, fish, or PowerShell:
rencom completion install bash --install # See COMPLETION.md for details
👩💻 Advanced: Local Development & Forking
If you want to run the API locally, contribute, or self-host:
-
Fork and Setup Locally
rencom fork- This will walk you through forking, configuring, and running the codebase locally.
-
Manual Setup (for reference)
- See the
forkcommand or theapi/,config/, andservices/folders for advanced configuration.
- See the
📚 API Documentation
- See PUBLIC_API_DOCS.md for full endpoint details.
- Or use the CLI:
rencom help
🤝 Contributing
- Use
rencom forkto get started as a contributor. - Standard PR workflow applies.
📄 License
MIT License
🆘 Support
- Create an issue in the GitHub repository
- Check the API documentation at
/docs
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rencom_cli-1.0.3.tar.gz.
File metadata
- Download URL: rencom_cli-1.0.3.tar.gz
- Upload date:
- Size: 36.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1e95e374fbed0bb43b96eff68d167f860c2b2f16c271bec2af31b19d024ba452
|
|
| MD5 |
a06179d4b13d4128f4545366643e17c4
|
|
| BLAKE2b-256 |
e990dc425f8f0451364228e4d5de4e6231572652bb6ae53f1d65e589044cdce0
|
File details
Details for the file rencom_cli-1.0.3-py3-none-any.whl.
File metadata
- Download URL: rencom_cli-1.0.3-py3-none-any.whl
- Upload date:
- Size: 41.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0761b494958233116c1b03b8531eea69a5ca0092507acc3b893005aecea9caee
|
|
| MD5 |
0815a5bd77b7cacbc7ff3cd5f706945f
|
|
| BLAKE2b-256 |
747d34c29e0617ed860dbef0e28c539f0dd2695efb9dde9e0769ac8e14b1328a
|