-
Notifications
You must be signed in to change notification settings - Fork 105
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #28 from seowings/dev
update readme information
- Loading branch information
Showing
2 changed files
with
138 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,80 @@ | ||
| # Static WordPress | ||
| # static-wordpress | ||
|
|
||
| A Python Library to prepare and deploy a static version of a WordPress Installation on Netlify (Static Hosting Service Provider). | ||
| Python Package for Converting WordPress Installation to a Static Website. | ||
|
|
||
| ## How to Use static-wordpress? | ||
| Please check our detailed tutorial (video/text) on [Static WordPress Tutorial](https://www.seowings.org/simply-static-tutorial/) to understand how it works. This package has a live documentation file on [documentation link](https://simply-static.netlify.app). | ||
|
|
||
| You can watch our youtube videos for more details. Here is an example on how to deploy a basic website. | ||
| ## How to Install static-wordpress? | ||
|
|
||
| [](http://www.youtube.com/watch?v=P85t1GpqkgM "Host Static WordPress On Netlify") | ||
| ### Windows Installer | ||
|
|
||
| ## Contributions | ||
| We provide an ``exe`` file of ``staticwordpress`` for the convenice of users. Please download the latest version from [release section](https://github.com/serpwings/staticwordpress/releases). | ||
|
|
||
| Contributions, suggestions, and comments are welcome. Please fork the repository and submit a pull request. | ||
|
|
||
| ### Source Code | ||
|
|
||
| ## About Us | ||
| - 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 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. | ||
| ) | ||
|
|
||
| This work is a collaborative effort of [seowings](https://seowings.org/) and [serpwings](https://serpwings.com/). | ||
| swp.download_zip_file() | ||
| swp.setup_zip_folders() | ||
| swp.add_404_page() | ||
| swp.add_robots_txt() | ||
| swp.add_redirects() | ||
| swp.add_search() | ||
| ``` | ||
|
|
||
| ## Documentation | ||
|
|
||
| ## LICENSE | ||
| Detailed documentation of all features is available at [staticwordpress documentation](https://static-wordpress.serpwings.com/). | ||
|
|
||
| ## 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 | ||
|
|
||
| - ``static-wordpress`` is released under [GPLv3+ License](https://github.com/serpwings/static-wordpress/blob/master/LICENSE). | ||
| - ``srcstaticwordpress\share\search.js`` is distributed without any additional licensing restrictions. Please consult ``src\search.js`` for more details. | ||
| This work is a collaborative effort of [seowings](https://www.seowings.org/), and [serpwings](https://serpwings.com/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,80 @@ | ||
| # Static WordPress | ||
| # staticwordpress | ||
|
|
||
| A Python Library to prepare and deploy a static version of a WordPress Installation on Netlify (Static Hosting Service Provider). | ||
| Python Package for Converting WordPress Installation to a Static Website. | ||
|
|
||
| ## How to Use static-wordpress? | ||
| Please check our detailed tutorial (video/text) on [Static WordPress Tutorial](https://www.seowings.org/simply-static-tutorial/){:target="_blank" rel="noopener"} to understand how it works. This package has a live documentation file on [documentation link](https://static-wordpress-docs.netlify.app/){:target="_blank" rel="noopener"}. | ||
|
|
||
| ## Contributions | ||
| ## How to Install staticwordpress? | ||
|
|
||
| Contributions, suggestions, and comments are welcome. Please fork the repository and submit a pull request. | ||
| ### 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/staticwordpress/releases). | ||
|
|
||
| ## About Us | ||
|
|
||
| This work is a collaborative effort of [seowings](https://seowings.org/){:target="_blank" rel="noopener"} and [serpwings](https://serpwings.com/){:target="_blank" rel="noopener"}. | ||
| ### 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() | ||
| ``` | ||
|
|
||
| ## LICENSE | ||
| ## 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 | ||
|
|
||
| - ``static-wordpress`` is released under [GPLv3+ License](https://github.com/serpwings/static-wordpress/blob/master/LICENSE). | ||
| - ``src\search.js`` is distributed without any additional licensing restrictions. Please consult ``src\search.js`` for more details. | ||
| This work is a collaborative effort of [seowings](https://www.seowings.org/), and [serpwings](https://serpwings.com/). |