diff options
author | CoprDistGit <infra@openeuler.org> | 2023-05-05 07:29:57 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-05-05 07:29:57 +0000 |
commit | bb9f86d892e747f126d78ee63cd3749b1c222ed3 (patch) | |
tree | 0e819e90a9828204e67523603f469118d33092f0 | |
parent | 1256a5d22dde19af5538f45bcf14d537a99b82d4 (diff) |
automatic import of python-notedownopeneuler20.03
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-notedown.spec | 411 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 413 insertions, 0 deletions
@@ -0,0 +1 @@ +/notedown-1.5.1.tar.gz diff --git a/python-notedown.spec b/python-notedown.spec new file mode 100644 index 0000000..cdae5b4 --- /dev/null +++ b/python-notedown.spec @@ -0,0 +1,411 @@ +%global _empty_manifest_terminate_build 0 +Name: python-notedown +Version: 1.5.1 +Release: 1 +Summary: Convert markdown to IPython notebook. +License: BSD 2-Clause +URL: http://github.com/aaren/notedown +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/58/1b/a926945216cb7d1d21abdbc975195bd7beb3bceafa41c186ecb95f8f9121/notedown-1.5.1.tar.gz +BuildArch: noarch + + +%description +`notedown <http://github.com/aaren/notedown>`__ is a simple tool to +create `IPython notebooks <http://www.ipython.org/notebook>`__ from +markdown (and r-markdown). +``notedown`` separates your markdown into code and not code. Code blocks +(fenced or indented) go into input cells, everything else goes into +markdown cells. +Usage: + notedown input.md > output.ipynb +Installation: + pip install notedown +or the latest on github: + pip install https://github.com/aaren/notedown/tarball/master +Conversion to markdown +~~~~~~~~~~~~~~~~~~~~~~ +Convert a notebook into markdown, stripping all outputs: + notedown input.ipynb --to markdown --strip > output.md +Convert a notebook into markdown, with output JSON intact: + notedown input.ipynb --to markdown > output_with_outputs.md +The outputs are placed as JSON in a code-block immediately after the +corresponding input code-block. ``notedown`` understands this convention +as well, so it is possible to convert this markdown-with-json back into +a notebook. +This means it is possible to edit markdown, convert to notebook, play +around a bit and convert back to markdown. +NB: currently, notebook and cell metadata is not preserved in the +conversion. +Strip the output cells from markdown: + notedown with_output_cells.md --to markdown --strip > no_output_cells.md +Running an IPython Notebook +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + notedown notebook.md --run > executed_notebook.ipynb +Editing in the browser *(new!)* +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +You can configure IPython / Jupyter to seamlessly use markdown as its +storage format. Add the following to your config file: + c.NotebookApp.contents_manager_class = 'notedown.NotedownContentsManager' +Now you can edit your markdown files in the browser, execute code, +create plots - all stored in markdown! +For Jupyter, your config file is ``jupyter_notebook_config.py`` in +``~/.jupyter``. For IPython your config is +``ipython_notebook_config.py`` in your ipython profile (probably +``~/.ipython/profile_default``): +R-markdown +~~~~~~~~~~ +You can use ``notedown`` to convert r-markdown as well. We just need to +tell ``notedown`` to use `knitr <yihui.name/knitr>`__ to convert the +r-markdown. This requires that you have R installed with +`knitr <yihui.name/knitr>`__. +Convert r-markdown into markdown: + notedown input.Rmd --to markdown --knit > output.md +Convert r-markdown into an IPython notebook: + notedown input.Rmd --knit > output.ipynb +- ``--rmagic`` will add ``%load_ext rpy2.ipython`` at the start of the + notebook, allowing you to execute code cells using the rmagic + extension (requires `rpy2 <http://rpy.sourceforge.net/>`__). notedown + does the appropriate ``%R`` cell magic automatically. +Magic +~~~~~ +Fenced code blocks annotated with a language other than python are read +into cells using IPython's ``%%`` `cell +magic <http://nbviewer.ipython.org/github/ipython/ipython/blob/1.x/examples/notebooks/Cell%20Magics.ipynb>`__. +You can disable this with ``--nomagic``. +- ``--pre`` lets you add arbitrary code to the start of the notebook. + e.g. + ``notedown file.md --pre '%matplotlib inline' 'import numpy as np'`` +How do I put a literal code block in my markdown? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +By using the ``--match`` argument. ``notedown`` defaults to converting +*all* code-blocks into code-cells. This behaviour can be changed by +giving a different argument to ``--match``: +- ``--match=all``: convert all code blocks (the default) +- ``--match=fenced``: only convert fenced code blocks +- ``--match=language``: only convert fenced code blocks with 'language' + as the syntax specifier (or any member of the block attributes) +- ``--match=strict``: only convert code blocks with Pandoc style + attributes containing 'python' and 'input' as classes. i.e. code + blocks must look like + ```{.python .input} + code + ``` +This isn't very interactive! +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Try editing the markdown in the IPython Notebook using the +``NotedownContentsManager`` (see above). +You can get an interactive ipython session in vim by using +`vim-ipython <http://www.github.com/ivanov/vim-ipython>`__, which allows +you to connect to a running ipython kernel. You can send code from vim +to ipython and get code completion from the running kernel. Try it! +Where's my syntax highlighting?! +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Try using either +`vim-markdown <https://github.com/tpope/vim-markdown>`__ or +`vim-pandoc <https://github.com/vim-pandoc/vim-pandoc>`__. Both are +clever enough to highlight code in markdown. +Rendering outputs in markdown +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +This is experimental! +Convert a notebook into markdown, rendering cell outputs as native +markdown elements: + notedown input.ipynb --render +This means that e.g. png outputs become ```` images and +that text is placed in the document. +Of course, you can use this in conjuntion with runipy to produce +markdown-with-code-and-figures from markdown-with-code: + notedown input.md --run --render > output.md +Not a notebook in sight! +The ``--render`` flag forces the output format to markdown. +TODO +~~~~ +- [x] Python 3 support +- [x] unicode support +- [x] IPython 3 support +- [x] IPython 4 (Jupyter) support +- [ ] Allow kernel specification + +%package -n python3-notedown +Summary: Convert markdown to IPython notebook. +Provides: python-notedown +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-notedown +`notedown <http://github.com/aaren/notedown>`__ is a simple tool to +create `IPython notebooks <http://www.ipython.org/notebook>`__ from +markdown (and r-markdown). +``notedown`` separates your markdown into code and not code. Code blocks +(fenced or indented) go into input cells, everything else goes into +markdown cells. +Usage: + notedown input.md > output.ipynb +Installation: + pip install notedown +or the latest on github: + pip install https://github.com/aaren/notedown/tarball/master +Conversion to markdown +~~~~~~~~~~~~~~~~~~~~~~ +Convert a notebook into markdown, stripping all outputs: + notedown input.ipynb --to markdown --strip > output.md +Convert a notebook into markdown, with output JSON intact: + notedown input.ipynb --to markdown > output_with_outputs.md +The outputs are placed as JSON in a code-block immediately after the +corresponding input code-block. ``notedown`` understands this convention +as well, so it is possible to convert this markdown-with-json back into +a notebook. +This means it is possible to edit markdown, convert to notebook, play +around a bit and convert back to markdown. +NB: currently, notebook and cell metadata is not preserved in the +conversion. +Strip the output cells from markdown: + notedown with_output_cells.md --to markdown --strip > no_output_cells.md +Running an IPython Notebook +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + notedown notebook.md --run > executed_notebook.ipynb +Editing in the browser *(new!)* +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +You can configure IPython / Jupyter to seamlessly use markdown as its +storage format. Add the following to your config file: + c.NotebookApp.contents_manager_class = 'notedown.NotedownContentsManager' +Now you can edit your markdown files in the browser, execute code, +create plots - all stored in markdown! +For Jupyter, your config file is ``jupyter_notebook_config.py`` in +``~/.jupyter``. For IPython your config is +``ipython_notebook_config.py`` in your ipython profile (probably +``~/.ipython/profile_default``): +R-markdown +~~~~~~~~~~ +You can use ``notedown`` to convert r-markdown as well. We just need to +tell ``notedown`` to use `knitr <yihui.name/knitr>`__ to convert the +r-markdown. This requires that you have R installed with +`knitr <yihui.name/knitr>`__. +Convert r-markdown into markdown: + notedown input.Rmd --to markdown --knit > output.md +Convert r-markdown into an IPython notebook: + notedown input.Rmd --knit > output.ipynb +- ``--rmagic`` will add ``%load_ext rpy2.ipython`` at the start of the + notebook, allowing you to execute code cells using the rmagic + extension (requires `rpy2 <http://rpy.sourceforge.net/>`__). notedown + does the appropriate ``%R`` cell magic automatically. +Magic +~~~~~ +Fenced code blocks annotated with a language other than python are read +into cells using IPython's ``%%`` `cell +magic <http://nbviewer.ipython.org/github/ipython/ipython/blob/1.x/examples/notebooks/Cell%20Magics.ipynb>`__. +You can disable this with ``--nomagic``. +- ``--pre`` lets you add arbitrary code to the start of the notebook. + e.g. + ``notedown file.md --pre '%matplotlib inline' 'import numpy as np'`` +How do I put a literal code block in my markdown? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +By using the ``--match`` argument. ``notedown`` defaults to converting +*all* code-blocks into code-cells. This behaviour can be changed by +giving a different argument to ``--match``: +- ``--match=all``: convert all code blocks (the default) +- ``--match=fenced``: only convert fenced code blocks +- ``--match=language``: only convert fenced code blocks with 'language' + as the syntax specifier (or any member of the block attributes) +- ``--match=strict``: only convert code blocks with Pandoc style + attributes containing 'python' and 'input' as classes. i.e. code + blocks must look like + ```{.python .input} + code + ``` +This isn't very interactive! +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Try editing the markdown in the IPython Notebook using the +``NotedownContentsManager`` (see above). +You can get an interactive ipython session in vim by using +`vim-ipython <http://www.github.com/ivanov/vim-ipython>`__, which allows +you to connect to a running ipython kernel. You can send code from vim +to ipython and get code completion from the running kernel. Try it! +Where's my syntax highlighting?! +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Try using either +`vim-markdown <https://github.com/tpope/vim-markdown>`__ or +`vim-pandoc <https://github.com/vim-pandoc/vim-pandoc>`__. Both are +clever enough to highlight code in markdown. +Rendering outputs in markdown +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +This is experimental! +Convert a notebook into markdown, rendering cell outputs as native +markdown elements: + notedown input.ipynb --render +This means that e.g. png outputs become ```` images and +that text is placed in the document. +Of course, you can use this in conjuntion with runipy to produce +markdown-with-code-and-figures from markdown-with-code: + notedown input.md --run --render > output.md +Not a notebook in sight! +The ``--render`` flag forces the output format to markdown. +TODO +~~~~ +- [x] Python 3 support +- [x] unicode support +- [x] IPython 3 support +- [x] IPython 4 (Jupyter) support +- [ ] Allow kernel specification + +%package help +Summary: Development documents and examples for notedown +Provides: python3-notedown-doc +%description help +`notedown <http://github.com/aaren/notedown>`__ is a simple tool to +create `IPython notebooks <http://www.ipython.org/notebook>`__ from +markdown (and r-markdown). +``notedown`` separates your markdown into code and not code. Code blocks +(fenced or indented) go into input cells, everything else goes into +markdown cells. +Usage: + notedown input.md > output.ipynb +Installation: + pip install notedown +or the latest on github: + pip install https://github.com/aaren/notedown/tarball/master +Conversion to markdown +~~~~~~~~~~~~~~~~~~~~~~ +Convert a notebook into markdown, stripping all outputs: + notedown input.ipynb --to markdown --strip > output.md +Convert a notebook into markdown, with output JSON intact: + notedown input.ipynb --to markdown > output_with_outputs.md +The outputs are placed as JSON in a code-block immediately after the +corresponding input code-block. ``notedown`` understands this convention +as well, so it is possible to convert this markdown-with-json back into +a notebook. +This means it is possible to edit markdown, convert to notebook, play +around a bit and convert back to markdown. +NB: currently, notebook and cell metadata is not preserved in the +conversion. +Strip the output cells from markdown: + notedown with_output_cells.md --to markdown --strip > no_output_cells.md +Running an IPython Notebook +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + notedown notebook.md --run > executed_notebook.ipynb +Editing in the browser *(new!)* +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +You can configure IPython / Jupyter to seamlessly use markdown as its +storage format. Add the following to your config file: + c.NotebookApp.contents_manager_class = 'notedown.NotedownContentsManager' +Now you can edit your markdown files in the browser, execute code, +create plots - all stored in markdown! +For Jupyter, your config file is ``jupyter_notebook_config.py`` in +``~/.jupyter``. For IPython your config is +``ipython_notebook_config.py`` in your ipython profile (probably +``~/.ipython/profile_default``): +R-markdown +~~~~~~~~~~ +You can use ``notedown`` to convert r-markdown as well. We just need to +tell ``notedown`` to use `knitr <yihui.name/knitr>`__ to convert the +r-markdown. This requires that you have R installed with +`knitr <yihui.name/knitr>`__. +Convert r-markdown into markdown: + notedown input.Rmd --to markdown --knit > output.md +Convert r-markdown into an IPython notebook: + notedown input.Rmd --knit > output.ipynb +- ``--rmagic`` will add ``%load_ext rpy2.ipython`` at the start of the + notebook, allowing you to execute code cells using the rmagic + extension (requires `rpy2 <http://rpy.sourceforge.net/>`__). notedown + does the appropriate ``%R`` cell magic automatically. +Magic +~~~~~ +Fenced code blocks annotated with a language other than python are read +into cells using IPython's ``%%`` `cell +magic <http://nbviewer.ipython.org/github/ipython/ipython/blob/1.x/examples/notebooks/Cell%20Magics.ipynb>`__. +You can disable this with ``--nomagic``. +- ``--pre`` lets you add arbitrary code to the start of the notebook. + e.g. + ``notedown file.md --pre '%matplotlib inline' 'import numpy as np'`` +How do I put a literal code block in my markdown? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +By using the ``--match`` argument. ``notedown`` defaults to converting +*all* code-blocks into code-cells. This behaviour can be changed by +giving a different argument to ``--match``: +- ``--match=all``: convert all code blocks (the default) +- ``--match=fenced``: only convert fenced code blocks +- ``--match=language``: only convert fenced code blocks with 'language' + as the syntax specifier (or any member of the block attributes) +- ``--match=strict``: only convert code blocks with Pandoc style + attributes containing 'python' and 'input' as classes. i.e. code + blocks must look like + ```{.python .input} + code + ``` +This isn't very interactive! +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Try editing the markdown in the IPython Notebook using the +``NotedownContentsManager`` (see above). +You can get an interactive ipython session in vim by using +`vim-ipython <http://www.github.com/ivanov/vim-ipython>`__, which allows +you to connect to a running ipython kernel. You can send code from vim +to ipython and get code completion from the running kernel. Try it! +Where's my syntax highlighting?! +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Try using either +`vim-markdown <https://github.com/tpope/vim-markdown>`__ or +`vim-pandoc <https://github.com/vim-pandoc/vim-pandoc>`__. Both are +clever enough to highlight code in markdown. +Rendering outputs in markdown +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +This is experimental! +Convert a notebook into markdown, rendering cell outputs as native +markdown elements: + notedown input.ipynb --render +This means that e.g. png outputs become ```` images and +that text is placed in the document. +Of course, you can use this in conjuntion with runipy to produce +markdown-with-code-and-figures from markdown-with-code: + notedown input.md --run --render > output.md +Not a notebook in sight! +The ``--render`` flag forces the output format to markdown. +TODO +~~~~ +- [x] Python 3 support +- [x] unicode support +- [x] IPython 3 support +- [x] IPython 4 (Jupyter) support +- [ ] Allow kernel specification + +%prep +%autosetup -n notedown-1.5.1 + +%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-notedown -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 1.5.1-1 +- Package Spec generated @@ -0,0 +1 @@ +00d72f37e8a64d7f4c66ea8e0d214236 notedown-1.5.1.tar.gz |