Skip to main content

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)

  1. Onboard Instantly

    rencom setup
    
    • This will guide you through API onboarding and create your API token.
  2. 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
  3. 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:

  1. Fork and Setup Locally

    rencom fork
    
    • This will walk you through forking, configuring, and running the codebase locally.
  2. Manual Setup (for reference)

    • See the fork command or the api/, config/, and services/ folders for advanced configuration.

📚 API Documentation

🤝 Contributing

  • Use rencom fork to 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

rencom_cli-1.0.2.tar.gz (35.6 kB view details)

Uploaded Source

Built Distribution

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

rencom_cli-1.0.2-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

Details for the file rencom_cli-1.0.2.tar.gz.

File metadata

  • Download URL: rencom_cli-1.0.2.tar.gz
  • Upload date:
  • Size: 35.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for rencom_cli-1.0.2.tar.gz
Algorithm Hash digest
SHA256 5bb337a608443d96f9e7b100f0d794abc027133a4f038ac2b74e1885c7b4806d
MD5 102568e51f3adaa036f80e1f8f073951
BLAKE2b-256 dbbe2b577a140197e393bc072bc585bd5722d3f341b3c738be0336f39448bc0a

See more details on using hashes here.

File details

Details for the file rencom_cli-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: rencom_cli-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 40.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for rencom_cli-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c82d5f0be183af49ca9a71c2b341ab632008ff1cef59c01c8308870936185a36
MD5 a26c376e93344e68f2e8f158437b1e36
BLAKE2b-256 24283c9b04d86d96ff4b1a2d1c99f4aae8773a8c5589d17f4980969bef00a867

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