PyMiner Documentation Server
This is a simple documentation server, mainly for PyMiner.
PyMiner文档服务器
这是一个简单的文档服务器，使用传统的后端渲染技术，主要采用了以下框架：
- WSGI服务器：
waitress - 后端服务器：
flask - Markdown：
markdown - 样式预处理器：
sass
目前非常不完善，只是一个临时的小服务器，欢迎各位一起完善。
接口
目前主要考虑两个接口：
创建服务器：server = Server(base_path)
启动服务器：server.run()
打开特定页面：server.show(path: str)。
这将直接调用webbrowser.open打开一个网页。
这个特定页面的路径应该是基于服务器的根路径base_path的相对路径，例如：
import os
from pyminer_algorithms_document_server.server import Server
if __name__ == '__main__':
server = Server(os.path.join(os.path.dirname(__file__), 'base'))
server.run()
server.show('lib1/func1.md')
from time import sleep
sleep(10)
应当注意的是，服务器跑在dameon线程中，当主程序退出时，子线程也会随之退出。
致谢
感谢nwljy提供的初版代码！
Release files for pyminer-algorithms-document-server 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyminer_algorithms_document_server-0.0.5.tar.gz | 4.7 kB | Without provenance | Details for pyminer_algorithms_document_server-0.0.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyminer_algorithms_document_server-0.0.5-py3-none-any.whl | Python 3 | none | any | Details for pyminer_algorithms_document_server-0.0.5-py3-none-any.whl |
Total release size: 11.4 kB
Release files / pyminer_algorithms_document_server-0.0.5.tar.gz
| Download URL | pyminer_algorithms_document_server-0.0.5.tar.gz |
|---|---|
| Size | 4.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3f0609a8b764b953c71d8f95d8439c3d84bff74445954cc200d47735ccacf873
|
|
BLAKE2b-256 checksum How to use checksums |
7d01100b7100fd978d0570530a60d28feb55b55f765fc70d5532b3842b1a3818
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.1
|
Release files / pyminer_algorithms_document_server-0.0.5-py3-none-any.whl
| Download URL | pyminer_algorithms_document_server-0.0.5-py3-none-any.whl |
|---|---|
| Size | 6.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1659ddd5184c8fb57ec90fa66a23e1e8762da230338b33d68942cd1691ab204d
|
|
BLAKE2b-256 checksum How to use checksums |
b54f47b509de5c509db44e0ebe0882937b6e7633e3decf822e86de0432228da0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.1
|
Security for pyminer-algorithms-document-server 0.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
