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.6.tar.gz (9.3 kB view details)

Uploaded Source

Built Distributions

wpdatabase2-0.0.6-py3.8.egg (23.8 kB view details)

Uploaded Source

wpdatabase2-0.0.6-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file wpdatabase2-0.0.6.tar.gz.

File metadata

  • Download URL: wpdatabase2-0.0.6.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.2

File hashes

Hashes for wpdatabase2-0.0.6.tar.gz
Algorithm Hash digest
SHA256 f8a3b377fef4acd6955e08b672d8593d8bb11cdb8c5bc83224a381ead2d9117e
MD5 119644981faf7fca8947bc31b0c430e4
BLAKE2b-256 795a87c8a856239998c596be1e04ac3b49eae7b9235d5828ab3df86f424776a6

See more details on using hashes here.

File details

Details for the file wpdatabase2-0.0.6-py3.8.egg.

File metadata

  • Download URL: wpdatabase2-0.0.6-py3.8.egg
  • Upload date:
  • Size: 23.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.2

File hashes

Hashes for wpdatabase2-0.0.6-py3.8.egg
Algorithm Hash digest
SHA256 13587418fa72d445103ccb119604cbadab9ff1caf4aceee682adbaaf3dc7256a
MD5 2617b4c1205e2397917ad125e75a00df
BLAKE2b-256 2c554110603ed4cc084cc12bfe957e9723100f49e4ec86c9b2264399dc9e1850

See more details on using hashes here.

File details

Details for the file wpdatabase2-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: wpdatabase2-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 11.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.2

File hashes

Hashes for wpdatabase2-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0efa31e8b9abcd11d444533b3b0dc1db59808e4824c1d5158a776544559a3dcb
MD5 10f0a00dd74ea543f58ff1571cf00f8a
BLAKE2b-256 76da01a97ce6c445ea16de5f41273c425c8d98c45d2c10d3e9e926c6aa88e433

See more details on using hashes here.

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