| Name | texbuild JSON |
| Version |
0.3
JSON |
| download |
| home_page | |
| Summary | Build system for LaTeX documents. |
| upload_time | 2023-12-17 22:37:21 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2022 Daniel Thomas Sank Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
latex
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# texbuild
`texbuild` is a build system for LaTeX documents.
It provides namespacing for labeled items.
Consider a LaTeX document composed of a main file
```
% main.tex
\documentclass{article}
\begin{document}
This is an equation
\begin{equation}
f(x) = x \label{equation}
\end{equation}
\input{foo.tex}
Let's refer to Equation~(\ref{equation}).
\end{document}
```
which includes a subordinate file
```
% foo.tex
\begin{equation}
f(x) = x^2 \label{equation}
\end{equation}
```
In this situation, `\ref{equation}` is ambiguous because both files use `\label{equation}` and the namespace for labeled items in LaTeX is global.
`texbuild` fixes this by supporting import semantics:
```
% main.tex
% -- begin imports --
% import foo as foo
% -- end imports --
\documentclass{article}
\begin{document}
This is an equation
\begin{equation}
f(x) = x \label{equation} % export
\end{equation}
\input{foo.tex}
We can refer to foo's Equation~(\ref{foo.equation}) or our own Equation~(\ref{equation}).
\end{document}
```
and
```
% foo.tex
\begin{equation}
f(x) = x^2 \label{equation} % export
\end{equation}
```
## Example
To see `texbuild` in action, install it and use it to build the example LaTeX documemt provided in this repo, by following these steps:
```
$ pip install texbuild
$ git clone https://github.com/DanielSank/texbuild
$ cd texbuild/example
$ texbuild
This produces `texbuild/example/texbuild-out/main.pdf`, which illustrates the use of `texbuild`.
Raw data
{
"_id": null,
"home_page": "",
"name": "texbuild",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "latex",
"author": "",
"author_email": "Daniel Sank <sank.daniel@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/14/83/29cdf45d5777506c123fb7ca5ec3e5c0a5e0f0830cf4a386a68d173bb8b7/texbuild-0.3.tar.gz",
"platform": null,
"description": "# texbuild\n\n`texbuild` is a build system for LaTeX documents.\nIt provides namespacing for labeled items.\nConsider a LaTeX document composed of a main file\n```\n% main.tex\n\n\\documentclass{article}\n\\begin{document}\nThis is an equation\n\\begin{equation}\n f(x) = x \\label{equation}\n\\end{equation}\n\\input{foo.tex}\nLet's refer to Equation~(\\ref{equation}).\n\\end{document}\n```\nwhich includes a subordinate file\n```\n% foo.tex\n\n\\begin{equation}\n f(x) = x^2 \\label{equation}\n\\end{equation}\n```\nIn this situation, `\\ref{equation}` is ambiguous because both files use `\\label{equation}` and the namespace for labeled items in LaTeX is global.\n`texbuild` fixes this by supporting import semantics:\n```\n% main.tex\n\n% -- begin imports --\n% import foo as foo\n% -- end imports --\n\n\\documentclass{article}\n\\begin{document}\nThis is an equation\n\\begin{equation}\n f(x) = x \\label{equation} % export\n\\end{equation}\n\\input{foo.tex}\nWe can refer to foo's Equation~(\\ref{foo.equation}) or our own Equation~(\\ref{equation}).\n\\end{document}\n```\nand\n```\n% foo.tex\n\n\\begin{equation}\n f(x) = x^2 \\label{equation} % export\n\\end{equation}\n```\n\n## Example\n\nTo see `texbuild` in action, install it and use it to build the example LaTeX documemt provided in this repo, by following these steps:\n```\n$ pip install texbuild\n$ git clone https://github.com/DanielSank/texbuild\n$ cd texbuild/example\n$ texbuild\n\nThis produces `texbuild/example/texbuild-out/main.pdf`, which illustrates the use of `texbuild`.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Daniel Thomas Sank Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Build system for LaTeX documents.",
"version": "0.3",
"project_urls": {
"Bug Tracker": "https://github.com/DanielSank/texbuild/issues",
"Homepage": "https://github.com/DanielSank/texbuild"
},
"split_keywords": [
"latex"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a92235b2848643fb5e9d95eb3d959899cbdf392fb71f3b780894953b8dd6fa6",
"md5": "2b966e9ad0f63251fbbc6f12d276d89a",
"sha256": "62f1841fb117cb893b358d40b97113ae950505667eb57eb7cda71a3a2d7e3f99"
},
"downloads": -1,
"filename": "texbuild-0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2b966e9ad0f63251fbbc6f12d276d89a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6804,
"upload_time": "2023-12-17T22:37:19",
"upload_time_iso_8601": "2023-12-17T22:37:19.889570Z",
"url": "https://files.pythonhosted.org/packages/3a/92/235b2848643fb5e9d95eb3d959899cbdf392fb71f3b780894953b8dd6fa6/texbuild-0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "148329cdf45d5777506c123fb7ca5ec3e5c0a5e0f0830cf4a386a68d173bb8b7",
"md5": "c2ec89a8e12fb87f15679e7018bdc65e",
"sha256": "c60cdb7782051e54554202525462d6fbece356fc4e68fdd604a3953452e280b3"
},
"downloads": -1,
"filename": "texbuild-0.3.tar.gz",
"has_sig": false,
"md5_digest": "c2ec89a8e12fb87f15679e7018bdc65e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5893,
"upload_time": "2023-12-17T22:37:21",
"upload_time_iso_8601": "2023-12-17T22:37:21.166351Z",
"url": "https://files.pythonhosted.org/packages/14/83/29cdf45d5777506c123fb7ca5ec3e5c0a5e0f0830cf4a386a68d173bb8b7/texbuild-0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-17 22:37:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DanielSank",
"github_project": "texbuild",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "texbuild"
}
