Metadata-Version: 2.1
Name: latexgit
Version: 0.8.25
Summary: A package for metaheuristic optimization in Python.
Home-page: https://thomasweise.github.io/latexgit_py
Author: Thomas Weise
Author-email: tweise@ustc.edu.cn
Maintainer: Thomas Weise
Maintainer-email: tweise@ustc.edu.cn
License: GPL 3.0
Project-URL: Documentation, https://thomasweise.github.io/latexgit_py
Project-URL: Source, https://github.com/thomasWeise/latexgit_py/
Project-URL: Tracker, https://github.com/thomasWeise/latexgit_py/issues
Keywords: LaTeX,git
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: pycommons >=0.8.56
Requires-Dist: strip-hints >=0.1.10
Requires-Dist: yapf >=0.40.2

[![make build](https://github.com/thomasWeise/latexgit_py/actions/workflows/build.yml/badge.svg)](https://github.com/thomasWeise/latexgit_py/actions/workflows/build.yml)
[![pypi version](https://img.shields.io/pypi/v/latexgit)](https://pypi.org/project/latexgit)
[![pypi downloads](https://img.shields.io/pypi/dw/latexgit.svg)](https://pypistats.org/packages/latexgit)
[![coverage report](https://thomasweise.github.io/latexgit_py/tc/badge.svg)](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).
