Saravanan666/pypi-org huggingface dataset:
Package: docution
ðŸš§ This is analphaversion of the project, a proof of concept. Looking for collaborators !Bring autodoc capabilities to your Notion workspace with DocutionDescriptionâ€¢Installâ€¢Usageâ€¢FAQâ€¢Contributeâ€¢RoadmapDocumentationDescriptionWriting documentation in Notion is an attractive alternative to other solutions :âœ¨ Neat interface, rich text editingðŸ‘¥ Easy to share and collaborate, while keeping it privateðŸš€ Already hosted !But Notion lacks features that makes the power of other solutions, like auto-documentation ! This is the role ofdocution: a python package and command line that updates your Notion pages with clean formatted documentation.InstallSimply run :pip install docutionUsageIn your Notion page, create a text block like follow :/docution my_module.my_functionAfter creating your integration and giving it access to your page, just run :docution --auth_token <secret> --page_id <id>And here you go ! Your Notion page is updated with your documentation :You can check thedocutionusage with :docution --helpPlease also check thedocumentationfor a full example with all the details !FAQWhy is it in alpha ?Currently, the official Notion API is inbeta, which means it can change anytime.Also, this project needs additional features that are not implemented in the Notion API yet to be fully functional. So for now, this is just a proof of concept.Checkout thecurrent limitationsfor more details.How does it work ?When you use thedocutioncommand line, the following happens :Retrieve all the blocks used in the Notion page with the given IDDetect the blocks that are a docution command (/docution a.b.c)Import the docstring of the objecta.b.cCorrectly format the docstring as Notion blocksWrite these blocks in your Notion pageContributeClone the repository locally, create your branch, push your changes and open a PR !Check if code is well-formated :pip install flake8flake8 . --count --max-complexity=10 --max-line-length=127 --statisticsRoadmapAdd missing functionality to be similar to sphinx (document public methods of class, etc...)Add option to specify path of moduleAdd option for private members, only specific member, etc...Should we add the module name (when documenting module) ? Add option for that ?Should we add only the name of the thing, or the whole path ? Add option for that ?Add option for dryrunChange parser topardoc? To handle other type of section, likeExample.Optimize API call to NOT do recursive calling (for now, no choice)Handle markdown ?Handle RST ?
Package: docutools
docutoolsMkDocs DocumentationTools For DevelopersThis repo is providing a set of plugins formkdocs materialcompatible documentation.It is meant to be used as a development dependency for projects, intended to be used mainly by the
developers themselves, i.e. for the more technical, code centric parts of software project documentation.Most notable feature:Literate Programming, i.e. dynamic code execution - tightly integrated within the mkdocs framework.Most plugins should work inothermkdocs themes as well. No guarantees though.FeatureGallerybashbashbashcall_flow_loggingcall_flow_loggingchartchartistcolumncommentsconvertconvertcov_reportdata_tablediag_diagramdrawiofind-pagesflowchartgit_changelogkrokikrokilightboxlprunnermake_badgesmarkmapmd-replacemd-replacemermaidpage-treeproject_dependenciespythonscreenshotstatsxterm
Package: docViewer
docVieweris a small tool to help you write document.Featuresrender source markup to htmllive preview while editingCurrent support following markup language:reStructuredTextplantumlUsageCommand Linerender doc to html file
*renderDoc*python-mdocViewer renderlive preview doc
*previewDoc*python-mdocViewer previewVim PluginInstall the pluginPlug 'zlqm/docViewer', { 'rtp': 'plugins/vim' }Editing a rst file and run command:LivePreviewDemoJust run this command and you can preview the doc in browser:docViewer ) previewDoc demo.rst
Start preview server [debug: False] bind to localhost:9000
visit http://localhost:9000/lite-preview?filename=demo.rst to preview
Package: docwalker
docwalkerQuickly view documentation in source code in a language-agnostic way.Docwalker processes custom characters in both inline and block comments to
quickly extract and present documentation comments in source code.For completeness, docwalker will also open entire Markdown files.Installation$>pipinstalldocwalker

$>docwalker--help# usage: docwalker [-h] [-f FILE] src_dir# DocWalker is a quick documentation filter/viewer for examining source code# documentation. By default, DocWalker creates a local config file, .dwconf, which# hosts the project-specific configuration.# positional arguments:#   src_dir               The source directory to examine.# options:#   -h, --help            show this help message and exit#   -f FILE, --file FILE  The config file to reference for custom parsing [default: '<src_dir>/.dwconf']Usage$>docwalker.# walks the current working directory.ConfigurationDefaultThe default configuration supports Python-esque syntax:[parser.inline]syntax=#@[parser.block]syntax_start="""@syntax_end=@"""[parser.listing]syntax_start=#<<syntax_end=#>>inline:#@ inline documentation hereblock:"""@ block documentation here @"""listings:#<< code goes here #>>Whendocwalkerfirst runs in a directory, a config file by the name.dwconfis generated with these default values. Simply edit this file to change what
characters should be processed.
Package: docwmd
Word Mover's Distance using Fast Word Mover's DistanceCalculates Word Mover's Distance usingFast Word Mover's Distance.InstallationBefore installing the package, check that you have already installed :NumpywmdNLTKSpacyen_core_web_lgpip install numpy
pip install wmd
pip install nltk
pip install spacy
python -m spacy download en_core_web_lgThenpip install docwmdTested on Linux and macOS.UsageYou must have the document you want to find the closest document as a string and the other documents as a list of strings.fromdocwmdimportdocWMDcalc=docWMD("Politician speaks to the media in Illinois.",["The president greets the press in Chicago.","The President delivers his inaugural address."])print(calc.get_closest())This returns the number of the nearest document and its distance.
Package: docwriter
FreeType DocwriterDocwriter is an API documentation generator for the FreeType Library that extracts and builds
Markdown docs from the FreeType header files.InstallationRunpip install docwriter(see (4) below for an automatedvirtualenvusage). It requires
Python >= 3.5 to run.Steps to Generate DocsEnsuredocwriteris installed usingpip.Clone the freetype repository fromhere.The FreeType build system can be used to generate the docs:shautogen.sh
./configure
makerefdocAlternatively, step 1 and the make target can be replaced withmake refdoc-venv. This installs
all requirements automatically in a separate virtual environment. More information onvirtualenvusage can be foundhere.Development UsageClone this repository.Clone the freetype repository fromhere.Runpip install -r requirements.txtin your environment (virtualenvrecommended).Copy theinclude/directory fromfreetypetodocwriter.Run in thedocwriterdirectory:python-mdocwriter\--prefix=ft2\--title=FreeType-2.13.1\--site=reference\--output=./docs\./include/freetype/*.h\./include/freetype/config/*.h\./include/freetype/cache/*.hThe markdown files are generated indocs/markdown/. Static site can be built by runningmkdocs buildindocs/. Read more about Mkdocshere.Usage Informationdocwriter [-h] [-t T] -o DIR [-p PRE] [-s DIR] [-q | -v] files [files ...]

DocWriter Usage information

positional arguments:
  files                 list of source files to parse, wildcards are allowed

optional arguments:
  -h, --help            show this help message and exit
  -t T, --title T       set project title, as in '-t "My Project"'
  -o DIR, --output DIR  set output directory, as in '-o mydir'
  -p PRE, --prefix PRE  set documentation prefix, as in '-p ft2'
  -s DIR, --site DIR    set 'site_dir' in mkdocs.yml [default=site]
  -q, --quiet           run quietly, show only errors
  -v, --verbose         increase output verbosityRunning TestsTo test on all supported Python versions:Make suretoxis installed:pipinstalltoxEnsure that all Python versions that you need to run the tests on are installed.Run tests:toxTo run specifc tests, use the-eargument. For example,tox-epy37,py38will run tests only on Python 3.7 and 3.8 (assuming they are installed). Seetox.inifor
all available environments.More information on running specific tox environments can be foundhere.Regression TestsRegression tests require internet access,git, and other FreeTypebuild
dependencies, and are
time-consuming. These tests are largely meant to run on Gitlab CI, but can also be run locally:tox-eregressionLicenseThis library is licensed under theFreeType License.HistoryThis library was originally written by David Turner asdocmakerwhich collected and presented
documentation in HTML. It has since been modified multiple times, including a major refactor to
allow multiple output formats. The currentdocwriteris the biggest rewrite, with lots of changes
and additions that allow it to be more flexible, readable, maintainable and usable.
Package: docx
IntroductionThe docx module creates, reads and writes Microsoft Office Word 2007 docx
files.These are referred to as ‘WordML’, ‘Office Open XML’ and ‘Open XML’ by
Microsoft.These documents can be opened in Microsoft Office 2007 / 2010, Microsoft Mac
Office 2008, Google Docs, OpenOffice.org 3, and Apple iWork 08.They alsovalidate as well formed XML.The module was created when I was looking for a Python support for MS Word
.docx files, but could only find various hacks involving COM automation,
calling .Net or Java, or automating OpenOffice or MS Office.The docx module has the following features:Making documentsFeatures for making documents include:ParagraphsBulletsNumbered listsDocument properties (author, company, etc)Multiple levels of headingsTablesSection and page breaksImagesEditing documentsThanks to the awesomeness of the lxml module, we can:Search and replaceExtract plain text of documentAdd and delete items anywhere within the documentChange document propertiesRun xpath queries against particular locations in the document - useful for
retrieving data from user-completed templates.Getting startedMaking and Modifying DocumentsJustdownload python docx.Usepiporeasy_installto fetch thelxmlandPILmodules.Then run:example-makedocument.pyCongratulations, you just made and then modified a Word document!Extracting Text from a DocumentIf you just want to extract the text from a Word file, run:example-extracttext.py 'Some word file.docx' 'new file.txt'Ideas & To Do ListFurther improvements to image handlingDocument health checksEggMarkdown conversion supportWe love forks, changes and pull requests!Check out the [HACKING](HACKING.markdown) to add your own changes!For this project on githubSend a pull request via github and we’ll add your changes!Want to talk? Need help?Emailpython-docx@googlegroups.comLicenseLicensed under theMIT licenseShort version: this code is copyrighted to me (Mike MacCana), I give you
permission to do what you want with it except remove my name from the credits.
See the LICENSE file for specific terms.
Package: docx2csv
Usage: docx2csv [OPTIONS] FILENAMEdocx to csv convertor (http://github.com/ivbeg/docx2csv)
Extracts tables from DOCX files as CSV or XLSX.Use command: “docx2csv convert <filename>” to run extraction. It will
create files like filename_1.csv, filename_2.csv for each table found.Options:--formatTEXTOutput format: CSV, XLSX--singlefileTEXTOutputs single XLS file with multiple sheets: True or False--sizefilterINTEGERFilters table by size number of rows--helpShow this message and exit.Examplesdocx2csv –format csv –sizefilter 3 CP_CONTRACT_160166.docxExtracts tables from file CP_CONTRACT_160166.docx with number of rows > 3 and
saves results as CSV files.CodeFunction “extract_tables” returns list of tables from docx file and function “extract” extracts tables as xlsx, xls or csv file. If ‘csv’ file selected you need to specify single file csv or multiple files>>> from docx2csv import extract_tables, extract
>>> tables = extract_tables('some_file.docx')returns list of tables
>>> extract(filename=’some_file.docx’, format=”xlsx”, output=’some_file.xlsx’)
saves all tables from some_file.docx to some_file.xlsx>>> extract(filename='some_file.docx', format="csv", singlefile=False)
saves all tables from some_file.docx to some_file_1.csv, some_file_2.csv and etc.Requirementsclickhttps://github.com/pallets/clickxlwthttps://github.com/python-excel/xlwtpython-docxhttps://github.com/python-openxml/python-docxopenpyxlhttps://bitbucket.org/openpyxl/openpyxl/srcAcknowledgementsThanks to Vsevolod Oparin (https://www.facebook.com/vsevolod.oparin) for optimized “extract_table” codeHistory0.1.1 (2022-01-30)Fixed requirements.txt and setup.py requirements0.1.0 (2018-01-14)First public release on PyPI and updated github code
Package: docx2md
docx2mdConverts Microsoft Word document files (.docx extension) to Markdownfiles.Installpip install docx2mdHow to useusage: python -m docx2md [-h] [-m] [-v] [--debug] SRC.docx DST.md



positional arguments:

  SRC.docx        Microsoft Word file to read

  DST.md          Markdown file to write



optional arguments:

  -h, --help      show this help message and exit

  -m, --md_table  use Markdown table notation instead of <table>

  -v, --version   show version

  --debug         for debugTablesA table is output as<tableid="table(n)">.idis the order ofoutput, starting from 1.If--md_tableis specified, the output will use|, but the titleline item will be#fixed.| # | # | # |

|---|---|---|

|a|b|c|

|d|e|f|

|g|h|i|PicturesImages will be output as<imgid="image(n)">. Theidis outputin order starting from 1.Examplessource:docxresult:MarkdownElements that can be convertedTables (including merged cells)Lists (also with numbers as bullets)HeadingsEmbedded imagesPage breaks (converted to<divclass="break"></div>)Line breaks within paragraphs (converted to<br>)Text boxes (inserted in the body)Elements that cannot be converted (only known ones)Table of ContentsText decoration (bold and etc…)LicenseMIT
Package: docx2pdf
docx2pdfConvertdocxtopdfon Windows or macOS directly using Microsoft Word (must be installed).On Windows, this is implemented viawin32comwhile on macOS this is implemented viaJXA(Javascript for Automation, aka AppleScript in JS).InstallOn macOS:brew install aljohri/-/docx2pdfViapipx:pipx install docx2pdfVia pip:pip install docx2pdfCLIusage: docx2pdf [-h] [--keep-active] [--version] input [output]

Example Usage:

Convert single docx file in-place from myfile.docx to myfile.pdf:
    docx2pdf myfile.docx

Batch convert docx folder in-place. Output PDFs will go in the same folder:
    docx2pdf myfolder/

Convert single docx file with explicit output filepath:
    docx2pdf input.docx output.docx

Convert single docx file and output to a different explicit folder:
    docx2pdf input.docx output_dir/

Batch convert docx folder. Output PDFs will go to a different explicit folder:
    docx2pdf input_dir/ output_dir/

positional arguments:
  input          input file or folder. batch converts entire folder or convert
                 single file
  output         output file or folder

optional arguments:
  -h, --help     show this help message and exit
  --keep-active  prevent closing word after conversion
  --version      display version and exitLibraryfromdocx2pdfimportconvertconvert("input.docx")convert("input.docx","output.pdf")convert("my_docx_folder/")See CLI docs above (or indocx2pdf --help) for all the different invocations. It is the same for the CLI and python library.Jupyter NotebookIf you are using this in the context of jupyter notebook, you will needipywidgetsfor the tqdm progress bar to render properly.pip install ipywidgets
jupyter nbextension enable --py widgetsnbextension
``
Package: docxbuilder
Docxbuilder is a Sphinx extension to build docx formatted documents.NoteThis extension is developed based onsphinx-docxbuilder. Though,
there is no compatibility between these extensions.RequirementsPython:2.7, 3.5 or latterSphinx:1.7.6 or laterInstallUse pip:pip install docxbuilderUsageAdd ‘docxbuilder’ toextensionsconfiguration ofconf.py:extensions=['docxbuilder']and build your documents:make docxYou can control the generated document by adding configurations intoconf.py:docx_documents=[('index','docxbuilder.docx',{'title':project,'creator':author,'subject':'A manual of docxbuilder',},True),]docx_style='path/to/custom_style.docx'docx_pagebreak_before_section=1For more details, seethe documentation.Style fileGenerated docx file’s design is customized by a style file
(The default style isdocxbuilder/docx/style.docx).
The style file is a docx file, which defines some paragraph,
character, and table styles.The below lists shows typical styles.Character styles:EmphasisStrongLiteralHyperlinkFootnote ReferenceParagraph styles:Body TextFootnote TextDefinition TermLiteral BlockImage Caption, Table Caution, Literal CaptionHeading 1, Heading 2, …, HeadingNTOC Headingtoc 1, toc 2, …, tocNList BulletList NumberTable styles:TableField ListAdmonition NoteTODOSupport math role and directive.Support tabular_col_spec directive.Support URL path for images.LicenceMIT Licence
Package: docx-charts
docx-chartsPython library for manipulating chart data in word documentsDisclaimer: this is a project made for a very specific usecase, because nothing better existed yet. No stability guarantees are made, and the API is subject to change :)Examplefromdocx_chartsimportDocumentdoc=Document('example.docx')chart=doc.find_charts_by_name('Chart 1')[0]data=chart.data()data['student_total']['CTB1002 Linear Algebra']=0.6chart.write(data)doc.save()
Package: docxedit
Mass Edit Word Documents But Keep Original FormattingEdit existing Word documents effortlessly and without changing the original formatting of the document.As great as the originaldocxlibrary is, this "keep same format" feature is not natively supported. However, this functionality is pretty useful if you want to automate document writing or editing and need to adhere to strict formatting rules. Hence, I wrote this small add-on module.InstallingWith pip:pip install docxeditDependenciesIncluded as a dependency:python-docxFunctionsMost of the functions in this module work primarily withruns, which are sequences of strings with the same formatting style.
This is how we can edit the document but keep the original format.Example UsagefromdocximportDocumentimportdocxeditdocument=Document()# Replace all instances of the word 'Hello' in the document by 'Goodbye'docxedit.replace_string(document,old_string='Hello',new_string='Goodbye')# Replace all instances of the word 'Hello' in the document by 'Goodbye' but only# up to paragraph 10docxedit.replace_string_up_to_paragraph(document,old_string='Hello',new_string='Goodbye',paragraph_number=10)# Remove any line that contains the word 'Hello' along with the next 5 linesdocxedit.remove_lines(document,first_line='Hello',number_of_lines=5)
Package: docxgen
docxgen is a python library to generate Microsoft Office Word 2007 Document.
Without knowing the details of the WordprocessingML, you may create a
beautiful Word Document, as:from docxgen import Document, title
doc = Document()
doc.update(
    title='Moby Dick',
    creator='Herman Melville',
    created=datetime(...)
)

body = doc.body
body.append(title('Moby Dick'))
body.append(subtitle('Moby Dick'))
body.append(h1('Chapter 1'))
body.append(paragraph([run('Call me Ishmael. Some years ago ...')]))

doc.save('/tmp/moby-dick.docx')This work is proudly sponsored bySurveyMonkey Inc, and licensed in MIT license.
Package: docxlatex
docxlatexA python library for extracting text and images from .docx files with LaTeX supportInfluenced bypython-docxandpython-docx2txt.
This project aims to expand the above libraries' functionality by allowing you to extract the equations in a .docx file and converts them to valid LaTeX,
primarily for use with MathJax.docxlatex DOES NOT convert the entire .docx file to a LaTeX source file.docxlatex is still in beta and does not work perfectly on all equations. However,
it does work with reasonable accuracy on standard symbols and equations, and works reliably when the equations in the
document have been converted to linear format.InstallationInstall using pippip install docxlatexUsageImport theDocumentclass fromdocxlatexfromdocxlateximportDocumentCreate aDocumentobject, giving it the path to the .docx file, and call theget_text()methoddoc=Document("path/to/document")text=doc.get_text()You can also set some settings on theDocumentobject to customize behaviour, like setting the delimiters that will go before and after an equation,
and flags to extract header and footer text. Read the documentation athrushikeshrv.github.io/docxlatexfor all options.doc.inline_delimiter="%"# "$" by defaultdoc.block_delimiter="%%"# "$$" by defaultLimitationdocxlatex currently requires all the mathematical equations in the .docx document to be converted into linear format to extract successfully. I am adding support for
equations in the professional format right now. Future releases will let you use it without having to use this workaround, but for now, make sure all the equations in the .docx file are converted into linear form.To convert all your equations into linear format, click on any equation, go to the Equation tab, make sure LaTeX is selected, and click on Convert → All - LinearPlease report any bugs on this project's GitHub pagedocxlatex/issuesTODOsAdd support for equations in professional formatting
Package: docx-live-reload
docx-live-reloadThis is a command line tool that is useful for experimenting with Word documents and learning about WordprocessingML structures.RequirementsIt works on Windows only and MS Word must be installed.UsageRunning:docx-live-reload example.docxWill create extract the content of the document to atest.docx__extractedfolder, making changes toexample.docx__extracted\word\document.xmlor..styles.xmlwill cause the document to reload in MS Word and show the changes.Also making changes toexample.docxusingpython-docxfor example will also cause the document to reload in MS Word and show the changes.After running the tool you can typerto manaually reload the document in MS Word and typeqto quit.Installationpip install docx-live-reload