From 66636c5e47b837d1a3040b766945d4f7f657d753 Mon Sep 17 00:00:00 2001 From: CoprDistGit Date: Mon, 29 May 2023 10:39:13 +0000 Subject: automatic import of python-mechanical-markdown --- .gitignore | 1 + python-mechanical-markdown.spec | 314 ++++++++++++++++++++++++++++++++++++++++ sources | 1 + 3 files changed, 316 insertions(+) create mode 100644 python-mechanical-markdown.spec create mode 100644 sources diff --git a/.gitignore b/.gitignore index e69de29..45a324c 100644 --- a/.gitignore +++ b/.gitignore @@ -0,0 +1 @@ +/mechanical-markdown-0.6.0.tar.gz diff --git a/python-mechanical-markdown.spec b/python-mechanical-markdown.spec new file mode 100644 index 0000000..47bd603 --- /dev/null +++ b/python-mechanical-markdown.spec @@ -0,0 +1,314 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mechanical-markdown +Version: 0.6.0 +Release: 1 +Summary: Run markdown recipes as shell scripts +License: MIT +URL: https://github.com/dapr/mechanical-markdown +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/25/db/4808fbd3c0d724a6f361b567e6bfea28dc4d2ec04c290403de0d736f24fe/mechanical-markdown-0.6.0.tar.gz +BuildArch: noarch + +Requires: python3-termcolor +Requires: python3-pyyaml +Requires: python3-mistune +Requires: python3-requests +Requires: python3-colorama + +%description +# Mechanical Markdown + +[![PyPI version](https://badge.fury.io/py/mechanical-markdown.svg)](https://badge.fury.io/py/mechanical-markdown) +[![codecov](https://codecov.io/gh/dapr/mechanical-markdown/branch/main/graph/badge.svg)](https://codecov.io/gh/dapr/mechanical-markdown) + +If you are using markdown to create tutorials for your users, these markdown files will often be a series of shell commands that a user will copy and paste into their shell of choice, along with detailed text description of what each command is doing. + +If you are regularly releasing software and having to manually verify your tutorials by copy pasting commands into a terminal every time you create a release, this is the package for you. + +The mechanical-markdown package is a Python library and corresponding shell script that allow you to run annotated markdown tutorials in an automated fashion. It will execute your markdown tutorials and verify the output according to expected stdout/stderr that you can embed directly into your markdown tutorials. + +# Installing + +This package requires a working python3 environment. You can install it using pip: + +```bash +pip install mechanical-markdown +``` + +This will install the Python module, and create the ```mm.py``` CLI script. + +# Quick Start + +Check out the [examples](./examples) for some quick and easy examples. + +# Usage + +## CLI + +A command line utility called ```mm.py``` is included with this package. + +```bash +% mm.py --help +usage: mm.py [-h] [--dry-run] [--manual] [--shell SHELL_CMD] markdown_file + +Auto validate markdown documentation + +positional arguments: + markdown_file + +optional arguments: + -h, --help show this help message and exit + --dry-run, -d Print out the commands we would run based on markdown_file + --manual, -m If your markdown_file contains manual validation steps, pause for user input + --shell SHELL_CMD, -s SHELL_CMD + Specify a different shell to use +``` + +## API + +Creating a MechanicalMarkdown instance from a string which contains a markdown document: +```python +from mechanical_markdown import MechanicalMarkdown + +mm = MechanicalMarkdown(markdown_string, shell="bash -c") +``` + +MechanicalMarkdown methods + +```python +# Returns a string describing the commands that would be run +output = mm.dryrun() +print(ouput) + +# Run the commands in the order they were specified and return a boolean for succes or failure +# Also returns a report summarizing what was run and stdout/sterr for each command +success, report = exectute_steps(manual, validate_links=False, link_retries=3) +print(report) + + +``` + +# Contributing + +Issues and contributions are always welcome! Please make sure your submissions have appropriate unit tests (see [tests](tests/)). + +This project was created to support [dapr/quickstarts](https://github.com/dapr/quickstarts). We're sharing it with the hope that it might be as usefull for somebody else as it was for us. + + + + +%package -n python3-mechanical-markdown +Summary: Run markdown recipes as shell scripts +Provides: python-mechanical-markdown +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mechanical-markdown +# Mechanical Markdown + +[![PyPI version](https://badge.fury.io/py/mechanical-markdown.svg)](https://badge.fury.io/py/mechanical-markdown) +[![codecov](https://codecov.io/gh/dapr/mechanical-markdown/branch/main/graph/badge.svg)](https://codecov.io/gh/dapr/mechanical-markdown) + +If you are using markdown to create tutorials for your users, these markdown files will often be a series of shell commands that a user will copy and paste into their shell of choice, along with detailed text description of what each command is doing. + +If you are regularly releasing software and having to manually verify your tutorials by copy pasting commands into a terminal every time you create a release, this is the package for you. + +The mechanical-markdown package is a Python library and corresponding shell script that allow you to run annotated markdown tutorials in an automated fashion. It will execute your markdown tutorials and verify the output according to expected stdout/stderr that you can embed directly into your markdown tutorials. + +# Installing + +This package requires a working python3 environment. You can install it using pip: + +```bash +pip install mechanical-markdown +``` + +This will install the Python module, and create the ```mm.py``` CLI script. + +# Quick Start + +Check out the [examples](./examples) for some quick and easy examples. + +# Usage + +## CLI + +A command line utility called ```mm.py``` is included with this package. + +```bash +% mm.py --help +usage: mm.py [-h] [--dry-run] [--manual] [--shell SHELL_CMD] markdown_file + +Auto validate markdown documentation + +positional arguments: + markdown_file + +optional arguments: + -h, --help show this help message and exit + --dry-run, -d Print out the commands we would run based on markdown_file + --manual, -m If your markdown_file contains manual validation steps, pause for user input + --shell SHELL_CMD, -s SHELL_CMD + Specify a different shell to use +``` + +## API + +Creating a MechanicalMarkdown instance from a string which contains a markdown document: +```python +from mechanical_markdown import MechanicalMarkdown + +mm = MechanicalMarkdown(markdown_string, shell="bash -c") +``` + +MechanicalMarkdown methods + +```python +# Returns a string describing the commands that would be run +output = mm.dryrun() +print(ouput) + +# Run the commands in the order they were specified and return a boolean for succes or failure +# Also returns a report summarizing what was run and stdout/sterr for each command +success, report = exectute_steps(manual, validate_links=False, link_retries=3) +print(report) + + +``` + +# Contributing + +Issues and contributions are always welcome! Please make sure your submissions have appropriate unit tests (see [tests](tests/)). + +This project was created to support [dapr/quickstarts](https://github.com/dapr/quickstarts). We're sharing it with the hope that it might be as usefull for somebody else as it was for us. + + + + +%package help +Summary: Development documents and examples for mechanical-markdown +Provides: python3-mechanical-markdown-doc +%description help +# Mechanical Markdown + +[![PyPI version](https://badge.fury.io/py/mechanical-markdown.svg)](https://badge.fury.io/py/mechanical-markdown) +[![codecov](https://codecov.io/gh/dapr/mechanical-markdown/branch/main/graph/badge.svg)](https://codecov.io/gh/dapr/mechanical-markdown) + +If you are using markdown to create tutorials for your users, these markdown files will often be a series of shell commands that a user will copy and paste into their shell of choice, along with detailed text description of what each command is doing. + +If you are regularly releasing software and having to manually verify your tutorials by copy pasting commands into a terminal every time you create a release, this is the package for you. + +The mechanical-markdown package is a Python library and corresponding shell script that allow you to run annotated markdown tutorials in an automated fashion. It will execute your markdown tutorials and verify the output according to expected stdout/stderr that you can embed directly into your markdown tutorials. + +# Installing + +This package requires a working python3 environment. You can install it using pip: + +```bash +pip install mechanical-markdown +``` + +This will install the Python module, and create the ```mm.py``` CLI script. + +# Quick Start + +Check out the [examples](./examples) for some quick and easy examples. + +# Usage + +## CLI + +A command line utility called ```mm.py``` is included with this package. + +```bash +% mm.py --help +usage: mm.py [-h] [--dry-run] [--manual] [--shell SHELL_CMD] markdown_file + +Auto validate markdown documentation + +positional arguments: + markdown_file + +optional arguments: + -h, --help show this help message and exit + --dry-run, -d Print out the commands we would run based on markdown_file + --manual, -m If your markdown_file contains manual validation steps, pause for user input + --shell SHELL_CMD, -s SHELL_CMD + Specify a different shell to use +``` + +## API + +Creating a MechanicalMarkdown instance from a string which contains a markdown document: +```python +from mechanical_markdown import MechanicalMarkdown + +mm = MechanicalMarkdown(markdown_string, shell="bash -c") +``` + +MechanicalMarkdown methods + +```python +# Returns a string describing the commands that would be run +output = mm.dryrun() +print(ouput) + +# Run the commands in the order they were specified and return a boolean for succes or failure +# Also returns a report summarizing what was run and stdout/sterr for each command +success, report = exectute_steps(manual, validate_links=False, link_retries=3) +print(report) + + +``` + +# Contributing + +Issues and contributions are always welcome! Please make sure your submissions have appropriate unit tests (see [tests](tests/)). + +This project was created to support [dapr/quickstarts](https://github.com/dapr/quickstarts). We're sharing it with the hope that it might be as usefull for somebody else as it was for us. + + + + +%prep +%autosetup -n mechanical-markdown-0.6.0 + +%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-mechanical-markdown -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 29 2023 Python_Bot - 0.6.0-1 +- Package Spec generated diff --git a/sources b/sources new file mode 100644 index 0000000..acd54fd --- /dev/null +++ b/sources @@ -0,0 +1 @@ +b053a289e8325b8ab8393a5ec3744a1b mechanical-markdown-0.6.0.tar.gz -- cgit v1.2.3