rchacon / wpadmin.py

Python module to assist with developing WordPress themes and plugins.

wpadmin

A single Python module to assist with developing WordPress themes and plugins. Inspiration comes from Django's startapp command.

Installation

$ pip install wpadmin

Usage

From the root of your WordPress project (directory containing wp-load.php):

$ wpadmin starttheme [--classic] my-theme-name

The starttheme command will create the following directory structure within the wp-contents/themes/ directory:

- my-theme-name
  - templates/
    - base.twig
  - static/
    - css/
    - images/
    - js/
  - 404.php
  - functions.php
  - index.php
  - README.md
  - style.css

The above structure assumes you will be using the Twig template engine via the Timber plugin. The starttheme command with the --classic option will create the following directory structure within the wp-contents/themes/ directory:

- my-theme-name
  - css/
  - images/
  - js/
  - 404.php
  - functions.php
  - index.php
  - README.md
  - style.css

To create a plugin skeleton:

$ wpadmin startplugin my-plugin-name

The startplugin command will create the following directory structure within the wp-contents/plugins/ directory:

- my-plugin-name
  - my-plugin.name.php
  - README.md

Running Tests

$ python -m unittest tests

wpadmin.py's Issues

wp-admin.py installplugin <plugin-name>

Install 3rd party plugin into the plugins folder.

rename commands to starttheme/startplugin

to payhomage to django-admin.py's startapp

wp-admin.py startproject <my-project>

Downloads WordPress core into the folder: "my-project"

wp-admin.py installtheme <theme-name>

install 3rd party theme into themes folder

Unit tests

test module

timber theme skeleton should be the default

remove need for --timber and make it the default. if user doesn't want timber theme then have them use -c or --classic

pip install

Register package on pypi.
Build egg, source, and window installer ‘distributables’.
Upload these ‘distributables’ to pypi.