معرفی شرکت ها
excerpts-2.1.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Excerpt Markdown Style Comments From a File
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | excerpts-2.1.0 |
| نام | excerpts |
| نسخه کتابخانه | 2.1.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Andreas Dominik Cullmann |
| ایمیل نویسنده | fvafrcu@mailbox.org |
| آدرس صفحه اصلی | https://gitlab.com/fvafrcu/excerpts |
| آدرس اینترنتی | https://pypi.org/project/excerpts/ |
| مجوز | BSD |
Excerpt Lines from Files
========================
.. image:: https://gitlab.com/fvafrCU/excerpts/badges/master/pipeline.svg
:target: https://gitlab.com/fvafrCU/excerpts/commits/master
.. image:: https://gitlab.com/fvafrCU/excerpts/badges/master/coverage.svg
:target: https://gitlab.com/fvafrCU/excerpts/commits/master
.. image:: https://img.shields.io/pypi/v/excerpts.svg
:target: https://pypi.python.org/pypi/excerpts
Introduction
------------
Ever read or wrote source files containing sectioning comments?
Especially in scientific and/or data analysis scripts I see a lot like
.. code:: python
### Collect Data
or
.. code:: python
###
### Remove Outliers
###
or even
.. code:: python
### 2.1 Descriptive Statistics
(`RStudio <https://rstudio.com>`_, an IDE for the
`programming language R <https://www.r-project.org/>`_ has
even come up with their own
`code sectioning and folding feature
<https://support.rstudio.com/hc/en-us/articles/200484568-Code-Folding-and-Sections>`_
that requires comments like
.. code:: python
# Hypothesis Testing ----
)
If these comments are markdown style section comments, we can excerpt them and
set a table of contents.
A First Example
---------------
Suppose you have the following code:
.. code::
#!/usr/bin/env python3
# #% A Tutorial Introduction
# ##% Getting Started
# no need to import anything
print('hello, world')
# ###% The First Python Function
def main():
print('hello, world')
main()
# ##% Variables and Arithmetic Expressions
print('some code')
# a comment
print('more code')
We can excerpt the comments marked by '%':
.. code::
# A Tutorial Introduction
## Getting Started
### The First Python Function
## Variables and Arithmetic Expressions
which is valid
`markdown <https://daringfireball.net/projects/markdown/>`_
that we can convert using
`pandoc <https://www.pandoc.org>`_
.
A Bit More Elaborated
---------------------
Suppose you have a file 'tests/files/some_file.txt' reading:
.. code::
#######% % All About Me
#######% % Me
####### The above defines a pandoc markdown header.
####### This is more text that will not be extracted.
#######% **This** is an example of a markdown paragraph: markdown
#######% recognizes only six levels of heading, so we use seven or
#######% more levels to mark "normal" text.
#######% Here you can use the full markdown
#######% [syntax](http://daringfireball.net/projects/markdown/syntax).
#######% *Note* the trailing line: markdown needs an empty line to end
#######% a paragraph.
#######%
#% A section
##% A subsection
### Not a subsubsection but a plain comment.
############% Another markdown paragraph.
############%
####### More text that will not be extracted.
Then excerpting the marked comments via
.. code:: python
import excerpts
file_name = 'tests/files/some_file.txt'
with open(file_name) as infile:
lines = infile.readlines()
excerpted = excerpts.excerpt(lines = lines, comment_character="#",
magic_character="%")
.. code:: python
print (''.join(str(p) for p in excerpted))
gives
.. code::
% All About Me
% Me
**This** is an example of a markdown paragraph: markdown
recognizes only six levels of heading, so we use seven or
more levels to mark "normal" text.
Here you can use the full markdown
[syntax](http://daringfireball.net/projects/markdown/syntax).
*Note* the trailing line: markdown needs an empty line to end
a paragraph.
# A section
## A subsection
Another markdown paragraph.
which again is valid
`markdown <https://daringfireball.net/projects/markdown/>`_
for
`pandoc <https://www.pandoc.org>`_
.
Working with Files
~~~~~~~~~~~~~~~~~~
If you want to excerpt from a file and run pandoc on the result, you can use
.. code:: python
excerpts.excerpts(file_name = file_name, comment_character="#",
magic_character="%", output_path="output", run_pandoc=True,
pandoc_formats="html")
to generate
`this file. <output/some_file.html>`_
Command Line Interface
......................
Excerpts has a command line interface that you may call from your
operating systems' command line instead of from python3:
.. code::
usage: excerpts [-h] [-O OUTPUT_PATH] [-o POSTFIX] [-e PREFIX]
[-c COMMENT_CHARACTER] [-m MAGIC_CHARACTER] [-v] [-x]
[-p]
[-n] [-l] [--no-latex] [--formats PANDOC_FORMATS]
[--no-pep8]
file
excerpt markdown-style comments from a file to markdown and
PEP8
----
PEP8 requires each "line of a block comment starts with a # and a single space".
excerpts takes care of this requirement by removing a single comment character
that is followed by a space and a sequence of comments characters.
Should you need to disable this behaviour, you can set allow_pep8 to False.
Requirements
------------
Excerpts needs python3.
Installation
------------
Try
pip3 install git+git://gitlab.com/fvafrcu/excerpts --upgrade --user
نیازمندی
| مقدار | نام |
|---|---|
| xtr | coverage; |
نحوه نصب
نصب پکیج whl excerpts-2.1.0:
pip install excerpts-2.1.0.whl
نصب پکیج tar.gz excerpts-2.1.0:
pip install excerpts-2.1.0.tar.gz