mirror of
https://gh.wpcy.net/https://github.com/serpwings/static-wordpress.git
synced 2026-05-07 06:59:26 +08:00
79 lines
No EOL
2.7 KiB
Markdown
79 lines
No EOL
2.7 KiB
Markdown
# staticwordpress
|
|
|
|
Python Package for Converting WordPress Installation to a Static Website.
|
|
|
|
|
|
## How to Install staticwordpress?
|
|
|
|
### 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
|
|
from staticwordpress.core.workflow import Workflow
|
|
from staticwordpress.core.constants import SOURCE, HOST
|
|
|
|
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 all post processed files will be saved
|
|
src_type_=SOURCE.ZIP, # Data Source, ZIP works perfectly right with 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://serpwings.com/static-wordpress/).
|
|
|
|
## TODO:
|
|
|
|
Following tasks need attention. This list is without any priority.
|
|
|
|
- Base Package
|
|
- Translations
|
|
- Redirects
|
|
- Vercel
|
|
- Cloudflare Pages
|
|
- others.
|
|
- 3rd Party Crawlers
|
|
- Process Folder data e.g. Simply Static
|
|
- Search
|
|
- Use Builint Interace
|
|
- Results for paramterized urls
|
|
- Dcoumentation
|
|
- GUI
|
|
- Recent Projects
|
|
- Improve Progressbar
|
|
|
|
## Contribute
|
|
|
|
Pull Requests, Feature Suggestions, and collaborations are welcome.
|
|
|
|
## About Us
|
|
|
|
This work is a collaborative effort of [seowings](https://www.seowings.org/), and [serpwings](https://serpwings.com/). |
