Various functionalities: folder synchronization, simple logging function, helpers to generate documentation with sphinx, sphinx extension, to run a command line, to run a notebook...
Project description
pyquickhelper: automation of many things
pyquickhelper is used to automate the release of the documentation such as automating Jenkins, converting notebooks into many formats, extending Sphinx with custom extensions… It assumes the project is organized on the same template as this one.
Functionalities
simple forms in notebooks
help generation including notebook conversion
folder synchronization
logging
help running unit tests
simple server to server sphinx documentation
file compression, zip, gzip, 7z
helpers for ipython notebooks (upgrade, offline run)
parser to quickly add a magic command in a notebook
Sphinx directives to integrate a blogpost in the documentation
mechanism to add forms in notebooks
Design
This project contains the following folders:
a source folder: src
a unit test folder: _unittests, go to this folder and run run_unittests.py
a folder: _doc, it will contain the documentation, a subfolder _doc/sphinxdox/source/blog contains blog post to communicate on the module
a file setup.py to build and to install the module, if the source were retrieve from GitHub, the script can also be called with the following extra options (python setup.py <option>): * clean_space: remove extra spaces in the code * build_sphinx: builds the documentation * unittests: run the unit tests, compute the code coverage
a script build_script.bat which produces many script on Windows to easily run the setup, generate the documentation, run the unit tests.
Examples
Convert a notebook into slides:
from pyquickhelper.helpgen import nb2slides
nb2slides("nb.ipynb", "convert.slides.html")
Merge two notebooks:
from pyquickhelper.ipythonhelper import read_nb
nb1 = read_nb("<file1>", kernel=False)
nb2 = read_nb("<file2>", kernel=False)
nb1.merge_notebook(nb2)
nb1.to_json(outfile)
Run a notebook:
from pyquickhelper.ipythonhelper import run_notebook
run_notebook("source.ipynb", working_dir="temp",
outfilename="modified.ipynb",
additional_path = [ "c:/temp/mymodule/src" ] )
Run a command line program:
from pyquickhelper.loghelper import run_cmd
out,err = run_cmd("python setup.py install", wait=True)
A sphinx extension to generate python documentation from a script:
.. runpython::
:showcode:
import sys
print("sys.version_info=", str(sys.version_info))
Links
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pyquickhelper-1.12.3821.tar.gz.
File metadata
- Download URL: pyquickhelper-1.12.3821.tar.gz
- Upload date:
- Size: 3.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e188614f73090ddfeb175dfe49b2ebad381925970d1915982e19ca5795c55c5b |
|
| MD5 | 720dc207542b5c88207274131d952ec7 |
|
| BLAKE2b-256 | cf6e7895d1106d65065ee15b35bc4d07b68a122ca2a3be78bfce720386da427c |
File details
Details for the file pyquickhelper-1.12.3821-py3-none-any.whl.
File metadata
- Download URL: pyquickhelper-1.12.3821-py3-none-any.whl
- Upload date:
- Size: 3.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 00e8a7c479a40debb89ee0fae85880ac11cdb81033379cc941feca0ae98ddfc9 |
|
| MD5 | 5b106baa0e4eed8e6328c99fe88b0c37 |
|
| BLAKE2b-256 | f7e72fd6e8a34295fa5ac9b0842126a30968f36ae9f5564544a57c9317b81a12 |
