Skip to main content

A Python package that checks and/or sets up a WordPress database.

Project description

py-wordpress-database

CircleCI

A big call out to @cariad for the original version of this library

A Python package that sets up a WordPress database.

wpdatabase2 will:

  • Provide a way to check to see if the wordpress database already exists
  • Return the version details of the wordpress database (if it exists)
  • Create the database, if it doesn't exist already.
  • Create the WordPress user, if it doesn't exist already.

wpdatabase2 is idempotent; if the database and the user already exist then it will return successfully.

Note that wpdatabase2 currently only supports MySQL databases.

Installation

pip install wpdatabase2

Prerequisites

wpdatabase2 assumes that the following properties have already been set in the wp-config.php file:

Property Description
DB_HOST Host or endpoint of the MySQL database server.
DB_USER WordPress database user.
DB_PASSWORD WordPress database password.

If you need help adding these values to wp-config.php then check out wpconfigr.

Command-line usage

If you need to specify to the database's administrator username and password:

python -m wpdatabase2 
        --wp-config      /www/wp-config.php \
        --admin-username garnet \
        --admin-password love

If you're deploying WordPress into Amazon Web Services (AWS) and have your administrator username and password held in Secrets Manager:

python -m wpdatabase2 
        --wp-config                       /www/wp-config.php \
        --admin-credentials-aws-secret-id AdminSecretID \
        --admin-credentials-aws-region    eu-west-1

Library usage

import wpdatabase2

wpdb = WpDatabase('path to wp-config.php')
print(wpdb.get_database_version())

Development

To install development dependencies:

pip install -e .[dev]

To run the tests:

python test.py

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

wpdatabase2-0.0.15.tar.gz (9.5 kB view hashes)

Uploaded Source

Built Distributions

wpdatabase2-0.0.15-py3.8.egg (24.1 kB view hashes)

Uploaded Source

wpdatabase2-0.0.15-py3-none-any.whl (12.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page