[](https://github.com/thomasWeise/latexgit_py/actions/workflows/build.yml)
[](https://pypi.org/project/latexgit)
[](https://pypistats.org/packages/latexgit)
[](https://thomasweise.github.io/latexgit_py/tc/index.html)
# latexgit: Accessing Git Repositories from LaTeX
- [Introduction](https://thomasweise.github.io/latexgit_py#introduction)
- [Installation](https://thomasweise.github.io/latexgit_py#installation)
- [License](https://thomasweise.github.io/latexgit_py#license)
- [Contact](https://thomasweise.github.io/latexgit_py#contact)
## 1. Introduction
`latexgit` is a preprocessor for accessing files from `git` repositories from LaTeX.
This Python package works in conjunction with the [`latexgit` LaTeX style](http://github.com/thomasWeise/latexgit_tex/).
Basically, the LaTeX package fills the `aux` file of a TeX project with repository file loading request.
This Python package here then parses the `aux` file, loads the requests, then performs the request, and adds commands with the resulting file paths and URLs to the `aux` file.
In the second pdfLaTeX compilation, these then become available.
## 2. Installation
In order to use this package and to, e.g., run the example codes, you need to first install it using [`pip`](https://pypi.org/project/pip/) or some other tool that can install packages from [PyPi](https://pypi.org).
You can install the newest version of this library from PyPi using [`pip`](https://pypi.org/project/pip/) by doing
```shell
pip install latexgit
```
This will install the latest official release of our package as well as [all dependencies](https://thomasweise.github.io/latexgit_py/requirements_txt.html).
If you want to install the latest source code version from GitHub (which may not yet be officially released), you can do
```shell
pip install repository+https://github.com/thomasWeise/latexgit_py.git
```
If you want to install the latest source code version from GitHub (which may not yet be officially released) and you have set up a private/public key for GitHub, you can also do:
```shell
repository clone ssh://repository@github.com/thomasWeise/latexgit_py
pip install latexgit_py
```
This may sometimes work better if you are having trouble reaching GitHub via `https` or `http`.
You can also clone the repository and then run a [`make` build](https://thomasweise.github.io/latexgit_py/Makefile.html), which will automatically install all dependencies, run all the tests, and then install the package on your system, too.
This will work only on Linux, though.
It also installs the [dependencies for building](https://thomasweise.github.io/latexgit_py/requirements-dev_txt.html), which include, e.g., those for unit testing and static analysis.
If this build completes successful, you can be sure that [`latexgit`](https://thomasweise.github.io/latexgit_py) will work properly on your machine.
All dependencies for using and running `latexgit` are listed at [here](https://thomasweise.github.io/latexgit_py/requirements_txt.html).
The additional dependencies for a [full `make` build](https://thomasweise.github.io/latexgit_py/Makefile.html), including unit tests, static analysis, and the generation of documentation are listed [here](https://thomasweise.github.io/latexgit_py/requirements-dev_txt.html).
## 3. License
[`latexgit`](https://thomasweise.github.io/latexgit_py) is a tool for accessing files in `git` repositories from `LaTeX`.
Copyright (C) 2023 [Thomas Weise](http://iao.hfuu.edu.cn/5) (汤卫思教授)
Dr. Thomas Weise (see [Contact](https://thomasweise.github.io/latexgit_py#contact)) holds the copyright of this package.
`latexgit` is provided to the public as open source software under the [GNU GENERAL PUBLIC LICENSE, Version 3, 29 June 2007](https://thomasweise.github.io/latexgit_py/LICENSE.html).
Terms for other licenses, e.g., for specific industrial applications, can be negotiated with Dr. Thomas Weise (who can be reached via the [contact information](https://thomasweise.github.io/latexgit_py#contact) below).
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program.
If not, see <https://www.gnu.org/licenses/>.
Please visit the [contributions guidelines](https://thomasweise.github.io/latexgit_py/CONTRIBUTING_md.html) for `latexgit` if you would like to contribute to our package.
If you have any concerns regarding security, please visit our [security policy](https://thomasweise.github.io/latexgit_py/SECURITY_md.html).
## 4. Contact
If you have any questions or suggestions, please contact
Prof. Dr. [Thomas Weise](http://iao.hfuu.edu.cn/5) (汤卫思教授) of the
Institute of Applied Optimization (应用优化研究所, [IAO](http://iao.hfuu.edu.cn)) of the
School of Artificial Intelligence and Big Data ([人工智能与大数据学院](http://www.hfuu.edu.cn/aibd/)) at
[Hefei University](http://www.hfuu.edu.cn/english/) ([合肥学院](http://www.hfuu.edu.cn/)) in
Hefei, Anhui, China (中国安徽省合肥市) via
email to [tweise@hfuu.edu.cn](mailto:tweise@hfuu.edu.cn) with CC to [tweise@ustc.edu.cn](mailto:tweise@ustc.edu.cn).
Raw data
{
"_id": null,
"home_page": "https://thomasweise.github.io/latexgit_py",
"name": "latexgit",
"maintainer": "Thomas Weise",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "tweise@ustc.edu.cn",
"keywords": "LaTeX, git",
"author": "Thomas Weise",
"author_email": "tweise@ustc.edu.cn",
"download_url": "https://files.pythonhosted.org/packages/99/dc/7bdaa2e7b26571268aca3179ea9c5d45d664ea4e5d4062da2b3d6e96e193/latexgit-0.8.25.tar.gz",
"platform": null,
"description": "[](https://github.com/thomasWeise/latexgit_py/actions/workflows/build.yml)\n[](https://pypi.org/project/latexgit)\n[](https://pypistats.org/packages/latexgit)\n[](https://thomasweise.github.io/latexgit_py/tc/index.html)\n\n\n# latexgit: Accessing Git Repositories from LaTeX\n\n- [Introduction](https://thomasweise.github.io/latexgit_py#introduction)\n- [Installation](https://thomasweise.github.io/latexgit_py#installation)\n- [License](https://thomasweise.github.io/latexgit_py#license)\n- [Contact](https://thomasweise.github.io/latexgit_py#contact)\n\n\n## 1. Introduction\n\n`latexgit` is a preprocessor for accessing files from `git` repositories from LaTeX.\nThis Python package works in conjunction with the [`latexgit` LaTeX style](http://github.com/thomasWeise/latexgit_tex/).\nBasically, the LaTeX package fills the `aux` file of a TeX project with repository file loading request.\nThis Python package here then parses the `aux` file, loads the requests, then performs the request, and adds commands with the resulting file paths and URLs to the `aux` file.\nIn the second pdfLaTeX compilation, these then become available.\n\n\n## 2. Installation\n\nIn order to use this package and to, e.g., run the example codes, you need to first install it using [`pip`](https://pypi.org/project/pip/) or some other tool that can install packages from [PyPi](https://pypi.org).\nYou can install the newest version of this library from PyPi using [`pip`](https://pypi.org/project/pip/) by doing\n\n```shell\npip install latexgit\n```\n\nThis will install the latest official release of our package as well as [all dependencies](https://thomasweise.github.io/latexgit_py/requirements_txt.html).\nIf you want to install the latest source code version from GitHub (which may not yet be officially released), you can do\n\n```shell\npip install repository+https://github.com/thomasWeise/latexgit_py.git\n```\n\nIf you want to install the latest source code version from GitHub (which may not yet be officially released) and you have set up a private/public key for GitHub, you can also do:\n\n```shell\nrepository clone ssh://repository@github.com/thomasWeise/latexgit_py\npip install latexgit_py\n```\n\nThis may sometimes work better if you are having trouble reaching GitHub via `https` or `http`.\n\nYou can also clone the repository and then run a [`make` build](https://thomasweise.github.io/latexgit_py/Makefile.html), which will automatically install all dependencies, run all the tests, and then install the package on your system, too.\nThis will work only on Linux, though.\nIt also installs the [dependencies for building](https://thomasweise.github.io/latexgit_py/requirements-dev_txt.html), which include, e.g., those for unit testing and static analysis.\nIf this build completes successful, you can be sure that [`latexgit`](https://thomasweise.github.io/latexgit_py) will work properly on your machine.\n\nAll dependencies for using and running `latexgit` are listed at [here](https://thomasweise.github.io/latexgit_py/requirements_txt.html).\nThe additional dependencies for a [full `make` build](https://thomasweise.github.io/latexgit_py/Makefile.html), including unit tests, static analysis, and the generation of documentation are listed [here](https://thomasweise.github.io/latexgit_py/requirements-dev_txt.html).\n\n\n## 3. License\n\n[`latexgit`](https://thomasweise.github.io/latexgit_py) is a tool for accessing files in `git` repositories from `LaTeX`.\n\nCopyright (C) 2023 [Thomas Weise](http://iao.hfuu.edu.cn/5) (\u6c64\u536b\u601d\u6559\u6388)\n\nDr. Thomas Weise (see [Contact](https://thomasweise.github.io/latexgit_py#contact)) holds the copyright of this package.\n\n`latexgit` is provided to the public as open source software under the [GNU GENERAL PUBLIC LICENSE, Version 3, 29 June 2007](https://thomasweise.github.io/latexgit_py/LICENSE.html).\nTerms for other licenses, e.g., for specific industrial applications, can be negotiated with Dr. Thomas Weise (who can be reached via the [contact information](https://thomasweise.github.io/latexgit_py#contact) below).\n\nThis program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.\nYou should have received a copy of the GNU General Public License along with this program.\nIf not, see <https://www.gnu.org/licenses/>.\n\nPlease visit the [contributions guidelines](https://thomasweise.github.io/latexgit_py/CONTRIBUTING_md.html) for `latexgit` if you would like to contribute to our package.\nIf you have any concerns regarding security, please visit our [security policy](https://thomasweise.github.io/latexgit_py/SECURITY_md.html).\n\n\n## 4. Contact\n\nIf you have any questions or suggestions, please contact\nProf. Dr. [Thomas Weise](http://iao.hfuu.edu.cn/5) (\u6c64\u536b\u601d\u6559\u6388) of the\nInstitute of Applied Optimization (\u5e94\u7528\u4f18\u5316\u7814\u7a76\u6240, [IAO](http://iao.hfuu.edu.cn)) of the\nSchool of Artificial Intelligence and Big Data ([\u4eba\u5de5\u667a\u80fd\u4e0e\u5927\u6570\u636e\u5b66\u9662](http://www.hfuu.edu.cn/aibd/)) at\n[Hefei University](http://www.hfuu.edu.cn/english/) ([\u5408\u80a5\u5b66\u9662](http://www.hfuu.edu.cn/)) in\nHefei, Anhui, China (\u4e2d\u56fd\u5b89\u5fbd\u7701\u5408\u80a5\u5e02) via\nemail to [tweise@hfuu.edu.cn](mailto:tweise@hfuu.edu.cn) with CC to [tweise@ustc.edu.cn](mailto:tweise@ustc.edu.cn).\n",
"bugtrack_url": null,
"license": "GPL 3.0",
"summary": "A package for metaheuristic optimization in Python.",
"version": "0.8.25",
"project_urls": {
"Documentation": "https://thomasweise.github.io/latexgit_py",
"Homepage": "https://thomasweise.github.io/latexgit_py",
"Source": "https://github.com/thomasWeise/latexgit_py/",
"Tracker": "https://github.com/thomasWeise/latexgit_py/issues"
},
"split_keywords": [
"latex",
" git"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a6c78b0f66c68277b3600a25ab5e67b9315f370490273350925e9f58baba3f44",
"md5": "dbf38bced29ad4a9832d79bfa72cf965",
"sha256": "9ab0057314bba63bd67ea8af2677bc841e18ef3224a88196d6e7dc4667f91a06"
},
"downloads": -1,
"filename": "latexgit-0.8.25-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dbf38bced29ad4a9832d79bfa72cf965",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 24779,
"upload_time": "2024-10-31T10:34:50",
"upload_time_iso_8601": "2024-10-31T10:34:50.933182Z",
"url": "https://files.pythonhosted.org/packages/a6/c7/8b0f66c68277b3600a25ab5e67b9315f370490273350925e9f58baba3f44/latexgit-0.8.25-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "99dc7bdaa2e7b26571268aca3179ea9c5d45d664ea4e5d4062da2b3d6e96e193",
"md5": "c107bc062a5e513cbb0fd4fa63c4bb0b",
"sha256": "2cf40f665d9318b3bf1162d0de3209124669bb651762823f237c7b0f67de75a9"
},
"downloads": -1,
"filename": "latexgit-0.8.25.tar.gz",
"has_sig": false,
"md5_digest": "c107bc062a5e513cbb0fd4fa63c4bb0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 25476,
"upload_time": "2024-10-31T10:34:52",
"upload_time_iso_8601": "2024-10-31T10:34:52.193611Z",
"url": "https://files.pythonhosted.org/packages/99/dc/7bdaa2e7b26571268aca3179ea9c5d45d664ea4e5d4062da2b3d6e96e193/latexgit-0.8.25.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-31 10:34:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thomasWeise",
"github_project": "latexgit_py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pycommons",
"specs": [
[
"==",
"0.8.57"
]
]
},
{
"name": "strip-hints",
"specs": [
[
"==",
"0.1.10"
]
]
},
{
"name": "yapf",
"specs": [
[
"==",
"0.40.2"
]
]
}
],
"lcname": "latexgit"
}
JSON
