summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore1
-rw-r--r--python-webscrapbook.spec362
-rw-r--r--sources1
3 files changed, 364 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index e69de29..090abf7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+/webscrapbook-1.8.3.tar.gz
diff --git a/python-webscrapbook.spec b/python-webscrapbook.spec
new file mode 100644
index 0000000..b51e797
--- /dev/null
+++ b/python-webscrapbook.spec
@@ -0,0 +1,362 @@
+%global _empty_manifest_terminate_build 0
+Name: python-webscrapbook
+Version: 1.8.3
+Release: 1
+Summary: A backend toolkit for management of WebScrapBook collection.
+License: MIT
+URL: https://github.com/danny0838/PyWebScrapBook
+Source0: https://mirrors.nju.edu.cn/pypi/web/packages/6d/b8/c6bece5fb59a25e4d30eb65b74d6505d3cd315452e1a818b75591961d3ae/webscrapbook-1.8.3.tar.gz
+BuildArch: noarch
+
+Requires: python3-flask
+Requires: python3-werkzeug
+Requires: python3-jinja2
+Requires: python3-lxml
+Requires: python3-commonmark
+Requires: python3-cryptography
+Requires: python3-flake8
+Requires: python3-pep8-naming
+Requires: python3-flake8-comprehensions
+Requires: python3-flake8-string-format
+Requires: python3-flake8-quotes
+Requires: python3-flake8-bugbear
+Requires: python3-flake8-isort
+Requires: python3-isort
+
+%description
+PyWebScrapBook is a command line toolkit and backend server for
+[WebScrapBook browser extension](https://github.com/danny0838/webscrapbook).
+
+## Features
+* Host any directory(s) as website(s).
+* Directory listing.
+* HTZ or MAFF archive file viewing.
+* Markdown file rendering.
+* Create, view, edit, and/or delete files via the web interface or API.
+* HTTP(S) authorization and simple ACL.
+* Tools for scrapbooks management, such as cache generating and data checking, exporting, importing, and conversion.
+
+## Usage
+
+### Install Python
+
+Install Python >= 3.7 from the [official site](https://www.python.org).
+
+Add python to `PATH` environment variable so that it can be run from the command line interface (CLI).
+
+### Install this package
+
+Run below command from CLI to install (or upgrade to) the latest version:
+
+ python -m pip install -U webscrapbook
+
+After installation, `wsb`, `webscrapbook`, and `wsbview` will be available from the CLI.
+
+### Usage overview
+
+Run `wsb --help` for help about available commands, which looks like:
+
+ usage: wsb [-h] [--version] [--root ROOT] COMMAND ...
+
+ positional arguments:
+ COMMAND the sub-command to run. Get usage help with e.g. wsb config -h
+ serve (s) serve the root directory
+ config (c)
+ show, generate, or edit the config
+ encrypt (e)
+ generate an encrypted password
+ cache (a) update fulltext cache and/or static site pages
+ check (k) check and fix scrapbook data
+ export (x)
+ export data items into archive files (*.wsba)
+ import (i)
+ import data items from archive files (*.wsba)
+ convert (v)
+ convert scrapbook data between different formats
+ help show detailed information about certain topics
+ view view archive file in the browser
+
+ optional arguments:
+ -h, --help show this help message and exit
+ --version show version information and exit
+ --root ROOT root directory to manipulate (default: current working directory)
+
+Run `wsb <command> --help` for help about `<command>`. For example, `wsb config --help` for help about `wsb config`.
+
+### Host a scrapbook
+
+Switch current working directory (CWD) to a directory you'd like to host.
+
+ cd /path/to/scrapbook
+
+> In Windows, an additional command or parameter to change drive may be required. For example, if the directory to host is `E:\path\to\scrapbook` while the current drive is `C`, an additional command `E:` (or parameter `/d`) is required besides `cd E:\path\to\scrapbook`.
+>
+> You can also use the shortcurt: `Shift + Right-click` on the desired folder and select `Open command window here` or `Open PowerShell window here`.
+
+Generate config files for the directory:
+
+ wsb config -ba
+
+> This step can be skipped if you want PyWebScrapBook default data structure instead. See [doc wiki](https://github.com/danny0838/webscrapbook/wiki/Backend) for more details.
+
+Run the generated `.wsb/serve.py` to start the server, or run below command from CLI:
+
+ wsb serve
+
+### Open archive file directly
+
+The `wsbview` executable supports opening an archive page (HTZ or MAFF) to view in the browser.
+
+Run `which wsbview` (or `where wsbview` in Windows) from CLI to get the path of `wsbview` executable, and set default application of MAFF/HTZ file to that executable to open them directly in the browser with double-click.
+
+### Configuration
+
+Run `wsb config -be` to edit configs for CWD. For documentation about configs, run `wsb help config`, or [read online](https://github.com/danny0838/PyWebScrapBook/blob/master/webscrapbook/resources/config.md).
+
+### Further documentation
+
+For more tips about how to configure PyWebScrapBook alongside WebScrapBook, visit [the documentation wiki for WebScrapBook](https://github.com/danny0838/webscrapbook/wiki/Backend).
+
+
+%package -n python3-webscrapbook
+Summary: A backend toolkit for management of WebScrapBook collection.
+Provides: python-webscrapbook
+BuildRequires: python3-devel
+BuildRequires: python3-setuptools
+BuildRequires: python3-pip
+%description -n python3-webscrapbook
+PyWebScrapBook is a command line toolkit and backend server for
+[WebScrapBook browser extension](https://github.com/danny0838/webscrapbook).
+
+## Features
+* Host any directory(s) as website(s).
+* Directory listing.
+* HTZ or MAFF archive file viewing.
+* Markdown file rendering.
+* Create, view, edit, and/or delete files via the web interface or API.
+* HTTP(S) authorization and simple ACL.
+* Tools for scrapbooks management, such as cache generating and data checking, exporting, importing, and conversion.
+
+## Usage
+
+### Install Python
+
+Install Python >= 3.7 from the [official site](https://www.python.org).
+
+Add python to `PATH` environment variable so that it can be run from the command line interface (CLI).
+
+### Install this package
+
+Run below command from CLI to install (or upgrade to) the latest version:
+
+ python -m pip install -U webscrapbook
+
+After installation, `wsb`, `webscrapbook`, and `wsbview` will be available from the CLI.
+
+### Usage overview
+
+Run `wsb --help` for help about available commands, which looks like:
+
+ usage: wsb [-h] [--version] [--root ROOT] COMMAND ...
+
+ positional arguments:
+ COMMAND the sub-command to run. Get usage help with e.g. wsb config -h
+ serve (s) serve the root directory
+ config (c)
+ show, generate, or edit the config
+ encrypt (e)
+ generate an encrypted password
+ cache (a) update fulltext cache and/or static site pages
+ check (k) check and fix scrapbook data
+ export (x)
+ export data items into archive files (*.wsba)
+ import (i)
+ import data items from archive files (*.wsba)
+ convert (v)
+ convert scrapbook data between different formats
+ help show detailed information about certain topics
+ view view archive file in the browser
+
+ optional arguments:
+ -h, --help show this help message and exit
+ --version show version information and exit
+ --root ROOT root directory to manipulate (default: current working directory)
+
+Run `wsb <command> --help` for help about `<command>`. For example, `wsb config --help` for help about `wsb config`.
+
+### Host a scrapbook
+
+Switch current working directory (CWD) to a directory you'd like to host.
+
+ cd /path/to/scrapbook
+
+> In Windows, an additional command or parameter to change drive may be required. For example, if the directory to host is `E:\path\to\scrapbook` while the current drive is `C`, an additional command `E:` (or parameter `/d`) is required besides `cd E:\path\to\scrapbook`.
+>
+> You can also use the shortcurt: `Shift + Right-click` on the desired folder and select `Open command window here` or `Open PowerShell window here`.
+
+Generate config files for the directory:
+
+ wsb config -ba
+
+> This step can be skipped if you want PyWebScrapBook default data structure instead. See [doc wiki](https://github.com/danny0838/webscrapbook/wiki/Backend) for more details.
+
+Run the generated `.wsb/serve.py` to start the server, or run below command from CLI:
+
+ wsb serve
+
+### Open archive file directly
+
+The `wsbview` executable supports opening an archive page (HTZ or MAFF) to view in the browser.
+
+Run `which wsbview` (or `where wsbview` in Windows) from CLI to get the path of `wsbview` executable, and set default application of MAFF/HTZ file to that executable to open them directly in the browser with double-click.
+
+### Configuration
+
+Run `wsb config -be` to edit configs for CWD. For documentation about configs, run `wsb help config`, or [read online](https://github.com/danny0838/PyWebScrapBook/blob/master/webscrapbook/resources/config.md).
+
+### Further documentation
+
+For more tips about how to configure PyWebScrapBook alongside WebScrapBook, visit [the documentation wiki for WebScrapBook](https://github.com/danny0838/webscrapbook/wiki/Backend).
+
+
+%package help
+Summary: Development documents and examples for webscrapbook
+Provides: python3-webscrapbook-doc
+%description help
+PyWebScrapBook is a command line toolkit and backend server for
+[WebScrapBook browser extension](https://github.com/danny0838/webscrapbook).
+
+## Features
+* Host any directory(s) as website(s).
+* Directory listing.
+* HTZ or MAFF archive file viewing.
+* Markdown file rendering.
+* Create, view, edit, and/or delete files via the web interface or API.
+* HTTP(S) authorization and simple ACL.
+* Tools for scrapbooks management, such as cache generating and data checking, exporting, importing, and conversion.
+
+## Usage
+
+### Install Python
+
+Install Python >= 3.7 from the [official site](https://www.python.org).
+
+Add python to `PATH` environment variable so that it can be run from the command line interface (CLI).
+
+### Install this package
+
+Run below command from CLI to install (or upgrade to) the latest version:
+
+ python -m pip install -U webscrapbook
+
+After installation, `wsb`, `webscrapbook`, and `wsbview` will be available from the CLI.
+
+### Usage overview
+
+Run `wsb --help` for help about available commands, which looks like:
+
+ usage: wsb [-h] [--version] [--root ROOT] COMMAND ...
+
+ positional arguments:
+ COMMAND the sub-command to run. Get usage help with e.g. wsb config -h
+ serve (s) serve the root directory
+ config (c)
+ show, generate, or edit the config
+ encrypt (e)
+ generate an encrypted password
+ cache (a) update fulltext cache and/or static site pages
+ check (k) check and fix scrapbook data
+ export (x)
+ export data items into archive files (*.wsba)
+ import (i)
+ import data items from archive files (*.wsba)
+ convert (v)
+ convert scrapbook data between different formats
+ help show detailed information about certain topics
+ view view archive file in the browser
+
+ optional arguments:
+ -h, --help show this help message and exit
+ --version show version information and exit
+ --root ROOT root directory to manipulate (default: current working directory)
+
+Run `wsb <command> --help` for help about `<command>`. For example, `wsb config --help` for help about `wsb config`.
+
+### Host a scrapbook
+
+Switch current working directory (CWD) to a directory you'd like to host.
+
+ cd /path/to/scrapbook
+
+> In Windows, an additional command or parameter to change drive may be required. For example, if the directory to host is `E:\path\to\scrapbook` while the current drive is `C`, an additional command `E:` (or parameter `/d`) is required besides `cd E:\path\to\scrapbook`.
+>
+> You can also use the shortcurt: `Shift + Right-click` on the desired folder and select `Open command window here` or `Open PowerShell window here`.
+
+Generate config files for the directory:
+
+ wsb config -ba
+
+> This step can be skipped if you want PyWebScrapBook default data structure instead. See [doc wiki](https://github.com/danny0838/webscrapbook/wiki/Backend) for more details.
+
+Run the generated `.wsb/serve.py` to start the server, or run below command from CLI:
+
+ wsb serve
+
+### Open archive file directly
+
+The `wsbview` executable supports opening an archive page (HTZ or MAFF) to view in the browser.
+
+Run `which wsbview` (or `where wsbview` in Windows) from CLI to get the path of `wsbview` executable, and set default application of MAFF/HTZ file to that executable to open them directly in the browser with double-click.
+
+### Configuration
+
+Run `wsb config -be` to edit configs for CWD. For documentation about configs, run `wsb help config`, or [read online](https://github.com/danny0838/PyWebScrapBook/blob/master/webscrapbook/resources/config.md).
+
+### Further documentation
+
+For more tips about how to configure PyWebScrapBook alongside WebScrapBook, visit [the documentation wiki for WebScrapBook](https://github.com/danny0838/webscrapbook/wiki/Backend).
+
+
+%prep
+%autosetup -n webscrapbook-1.8.3
+
+%build
+%py3_build
+
+%install
+%py3_install
+install -d -m755 %{buildroot}/%{_pkgdocdir}
+if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
+if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
+if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
+if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
+pushd %{buildroot}
+if [ -d usr/lib ]; then
+ find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/lib64 ]; then
+ find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/bin ]; then
+ find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/sbin ]; then
+ find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+touch doclist.lst
+if [ -d usr/share/man ]; then
+ find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
+fi
+popd
+mv %{buildroot}/filelist.lst .
+mv %{buildroot}/doclist.lst .
+
+%files -n python3-webscrapbook -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Thu Mar 09 2023 Python_Bot <Python_Bot@openeuler.org> - 1.8.3-1
+- Package Spec generated
diff --git a/sources b/sources
new file mode 100644
index 0000000..359fceb
--- /dev/null
+++ b/sources
@@ -0,0 +1 @@
+c6fd48cc51b5b3275329a0881b2c2167 webscrapbook-1.8.3.tar.gz