https://github.com/serpwings/static-wordpress

Python Library for Static WordPress (Autmated Crawling, Post-Processing and Hosting)
https://github.com/serpwings/static-wordpress

lunrjs netlify simply-static ssg static-site-generator static-wordpress wordpress wordpress-plugin

Last synced: about 2 months ago
JSON representation

Python Library for Static WordPress (Autmated Crawling, Post-Processing and Hosting)

• Host: GitHub
• URL: https://github.com/serpwings/static-wordpress
• Owner: serpwings
• License: gpl-3.0
• Created: 2023-03-05T17:50:50.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-08-14T23:14:45.000Z (10 months ago)
• Last Synced: 2025-12-15T12:17:57.254Z (6 months ago)
• Topics: lunrjs, netlify, simply-static, ssg, static-site-generator, static-wordpress, wordpress, wordpress-plugin
• Language: Python
• Homepage: https://static-wordpress-docs.netlify.app/
• Size: 3.24 MB
• Stars: 217
• Watchers: 1
• Forks: 109
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# static-wordpress

Python Package for Converting WordPress Installation to a Static Website.

[![build_Tests](https://github.com/serpwings/static-wordpress/actions/workflows/tests.yml/badge.svg)](https://github.com/serpwings/static-wordpress/actions/workflows/tests.yml)

[![license](https://img.shields.io/pypi/l/staticwordpress.svg?style=flat-square "Project License: GPLv3+")](https://github.com/serpwings/staticwordpress/blob/master/LICENSE)

[![status](https://img.shields.io/pypi/status/staticwordpress.svg?style=flat-square "Project Development Status")](https://github.com/serpwings/staticwordpress/milestone/1)

[![pypi_version](https://img.shields.io/pypi/v/staticwordpress.svg?style=flat-square "Available on PyPi - the Python Package Index")](https://pypi.python.org/pypi/staticwordpress)

[![supported_python_versions](https://img.shields.io/pypi/pyversions/staticwordpress.svg?style=flat-square "Supported Python Version")](https://pypi.python.org/pypi/staticwordpress)

## Desktop Version

![staticwordpress-gui](docs/img/staticwordpress-gui.png)

## How to Install static-wordpress?

### Windows Installer

We provide an ``exe`` file of ``staticwordpress`` for the convenice of users. Please download the latest version from [release section](https://github.com/serpwings/static-wordpress/releases).

### Source Code

- Clone or download this repository to your computer.

- Create a virtual environment using ``python -m .venv venv``

- Navigate to the downloaded directory and then install all required dependencies using ``pip install -e .``

- Once all dependencies are met, then start **staticwordpress** by typing ``staticwordpress`` on commandline.

## Development

This package is available at ``pypi`` and you can install it with ``pip install staticwordpress`` command. It will also install required additional libraries/Python Packages automatically.

Once installed, you can implement customized workflows. Here is an example of post processing simply-static-zip file. 

```python

import logging

from staticwordpress.core.workflow import Workflow

from staticwordpress.core.constants import SOURCE, HOST

# enable logging for all functions.

logging.basicConfig(

        format="%(asctime)s - %(levelname)s - %(message)s",

        level=logging.DEBUG,

        stream=sys.stdout,

)

swp = Workflow()

swp.create_project(

        project_name_="simply-static-zip-deploy",

        wp_user_=env_wp_user, # your wordpress username

        wp_api_token_=env_wp_api_token, # wordpress xml api token

        src_url_=env_src_url, # source url where WordPress is hosted

        dst_url_=env_dst_url, # destination url where you want to host Static version

        output_folder_=env_output, # Output folder location, where processed files will be saved

        src_type_=SOURCE.ZIP, # Data Source e.g. ZIP file from Simply Static WordPress Plugin

        host_type_=HOST.NETLIFY, # Host, where you want to deplyo your website.

    )

swp.download_zip_file()

swp.setup_zip_folders()

swp.add_404_page()

swp.add_robots_txt()

swp.add_redirects()

swp.add_search()

```

## Documentation

Detailed documentation of all features is available at [staticwordpress documentation](https://static-wordpress-docs.netlify.app/).

## Contribute

Pull Requests, Feature Suggestions, and collaborations are welcome.

## ICONS

Icons used in this project are obtained from Google [Fonts Material Symbols](https://fonts.google.com/icons?selected=Material+Symbols+Outlined:search:FILL@0;wght@400;GRAD@0;opsz@24) 

## About Us

This work is a collaborative effort of [seowings](https://www.seowings.org/), and [serpwings](https://serpwings.com/).