Plugie CLI

This simple CLI tool allows you to set up Plugie and copy the necessary files to get started with your project.

Installation

Plugie CLI is available as a PyPI package. You can install it using pip:

pip install djangocms_plugie

Usage

To get started with Plugie, you can run the following command:

plugie <project_dir>

where <project_dir> is your Django project directory.

This command will do the following:

1. Create a plugie/custom_methods directory in your project directory, including a default.py file for serialization and deserialization of the most common data types. For more information on how to create custom methods, see the Add Custom Serializer‐Deserializer Methods

2. Create a plugie_tests directory and include django tests for Plugie.

3. Create a plugie_config.json file in your project directory, which will contain the configuration for Plugie. Read more about the configuration options in the plugie_config.json section.

Available Commands

You can see the available commands by running:

plugie --help

# usage: plugie [-h] [-v] [project_dir]
#
# Setup djangocms_plugie project.
# 
# positional arguments:
#   project_dir    The directory of the project to setup
# 
# optional arguments:
#   -h, --help     show this help message and exit
#   -v, --version  Show the version of plugie
#