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

Uploaded Source

Built Distributions

wpdatabase2-0.0.4-py3.8.egg (23.9 kB view details)

Uploaded Source

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wpdatabase2-0.0.4.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.4.tar.gz
Algorithm Hash digest
SHA256 6dfd26c8f6384a81d849a4b615135c17428ca978e2e6ad566b9884e049e7f1f9
MD5 8e667cf9660ad1ca53865fd1aa4fd693
BLAKE2b-256 3d85372a85d70e64ea83fc29047dcd8c7253c7bc008145290a17b35876223e3e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wpdatabase2-0.0.4-py3.8.egg
  • Upload date:
  • Size: 23.9 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.4-py3.8.egg
Algorithm Hash digest
SHA256 0e3cbb7739f11b073753f263df2cee4814b3258a1a8ef8a2442d1beba2234e77
MD5 5f1e7094bfe1e7bf4666987a2ef811dc
BLAKE2b-256 7ae8cdeb43be62bf897ede2a64661b6827538d6c893030eb47fbc99f7a46fe57

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wpdatabase2-0.0.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 92034b2cc37d0b5b95cf7d917c759a8dd477d8ce5593672d3a49f5dfdc046387
MD5 7e006b8351d4d0841d1f2430b21c20b8
BLAKE2b-256 26b08a00c92287059c00d3dbf5517ac0b834817153b524aae4ac841bafd22289

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