Metadata-Version: 2.1
Name: texbox
Version: 0.2.1
Summary: An opinionated Python CLI to create, organize, and prettify specific files of a LaTeX project.
Home-page: https://github.com/joaopalmeiro/texbox
Author: João Palmeiro
Author-email: jm.palmeiro@campus.fct.unl.pt
License: MIT
Project-URL: Bug Reports, https://github.com/joaopalmeiro/texbox/issues
Project-URL: Source, https://github.com/joaopalmeiro/texbox
Description: # texbox
        
        [![PyPI - Version](https://img.shields.io/pypi/v/texbox)](https://pypi.org/project/texbox/)
        ![Publish to PyPI](https://github.com/joaopalmeiro/texbox/workflows/Publish%20to%20PyPI/badge.svg)
        
        An opinionated Python CLI to create, organize, and prettify specific files of a LaTeX project.
        
        ## Quickstart (CLI)
        
        ### texbox_acronyms
        
        ```text
        usage: texbox_acronyms [-h] -i PATH [-b {label,abbrv,full}] [-d]
        
        Sort acronyms from an `acronyms.tex` file.
        
        required arguments:
          -i, --input PATH      The path to the `acronyms.tex` file to be sorted.
        
        optional arguments:
          -b, --by {label,abbrv,full}
                                Macro argument name to sort by. (default: label)
          -d, --descending      Sort descending instead of ascending.
        ```
        
        ### texbox_tables
        
        ```text
        usage: texbox_tables [-h] -i PATH -o PATH -ck COL -t COL [-c COLS] [-a COLS]
                             [-ac COLS] [-r] [-b] [-ca STR] [-sb COLS] [-fl PATH]
                             [-pp STR]
        
        Generate a LaTeX table from a bibliography-based file.
        
        required arguments:
          -i, --input PATH      The path to the file to be tabulated.
          -o, --output PATH     The path to the file for the generated LaTeX table.
          -ck, --cite-key-col COL
                                The column name for the cite key.
          -t, --title-col COL   The column name for the title.
        
        optional arguments:
          -c, --cols COLS       The subset of columns to maintain. By default, all
                                columns are kept except the title column.
          -a, --acronym-col-names COLS
                                The subset of columns whose name is an acronym and
                                which must be wrapped in a macro. By default, no
                                column name is considered an acronym.
          -ac, --acronym-cols COLS
                                The subset of columns whose comma-separated values are
                                acronyms and which must be wrapped in a macro. By
                                default, no columns are considered to have acronyms.
          -r, --rotate          Rotate the generated LaTeX table (landscape mode).
          -b, --break-col-headings
                                Break the column headings of the generated LaTeX table
                                with more than one word.
          -ca, --caption STR    The caption for the generated LaTeX table.
          -sb, --sort-by COLS   The subset of columns to sort by.
          -fl, --footer-legend PATH
                                The path to the file with the footer legend entries.
          -pp, --table-position-params STR
                                The position parameters for the table environment. By
                                default, no parameters are specified.
        ```
        
        ## Development quickstart
        
        - `make init`.
        - `make shell` or `pipenv shell`.
        
        ## References
        
        - [LaTeX/Glossary](https://en.wikibooks.org/wiki/LaTeX/Glossary).
        - [Publishing package distribution releases using GitHub Actions CI/CD workflows](https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/).
        - [The Comprehensive LaTeX Symbol List](https://math.uoregon.edu/wp-content/uploads/2014/12/compsymb-1qyb3zd.pdf).
        
        ## Notes
        
        - `pipenv install --python 3.6 --dev`.
        - `pipenv install -e .`.
        - `pipenv install pyparsing`.
        - `pipenv graph`.
        - Delete tag: `git push --delete origin tagname`.
        - `python -m texbox.cli_acronyms -h`.
        - [`pandas.DataFrame.to_latex`](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.to_latex.html) documentation.
        - `texbox_tables -i literature_review_summary.csv -ck "Cite Key" -o table1.tex -t "Paper" -c "Year,OOTL,BC,MCC,Other Tasks,uFeatures,Multiple Models,Tracking of Changes,OOTB,Context,Target Group,Model,OSS" -a "OOTL,BC,MCC,uFeatures,OOTB,OSS" -r -b -ca "Summary of visual tools for Model Evaluation." -sb "Year" -fl literature_review_summary_footer.txt -ac "Target Group"`.
        - `texbox_tables -i literature_review_summary.csv -ck "Cite Key" -o table1.tex -t "Paper" -c "Year,Granularity" -ca "Summary of granularities of visual tools for Model Evaluation." -sb "Year" -pp h`.
        
Keywords: cli,refactor,sort,prettify,acronyms,latex
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Terminals
Classifier: Topic :: Text Processing :: Markup :: LaTeX
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.6, <=3.8
Description-Content-Type: text/markdown
