latex-forge 0.2.0__tar.gz

latex_forge-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Thomas Gourmelen
+
+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.

latex_forge-0.2.0/PKG-INFO

@@ -0,0 +1,274 @@
+Metadata-Version: 2.4
+Name: latex-forge
+Version: 0.2.0
+Summary: CLI for creating standalone LaTeX projects from this toolbox.
+Author-email: Thomas Gourmelen <thomas.gourmelen@icloud.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/thmsgo18/latex-forge
+Project-URL: Repository, https://github.com/thmsgo18/latex-forge
+Project-URL: Bug Tracker, https://github.com/thmsgo18/latex-forge/issues
+Keywords: latex,templates,cli,academic,report,research,university
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: argcomplete>=3.0
+Requires-Dist: tomli>=1.1.0; python_version < "3.11"
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Dynamic: license-file
+
+# LaTeX Toolbox
+
+<p align="center">
+  <img src="docs/assets/latex-forge-logo.png" alt="LaTeX Toolbox" width="480">
+</p>
+
+<p align="center">
+  Skip the setup. Start writing. Everything you need, nothing more.
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/latex-forge/"><img src="https://img.shields.io/pypi/v/latex-forge?style=for-the-badge&color=blue" alt="PyPI version"></a>
+  <a href="https://github.com/thmsgo18/latex-forge/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/thmsgo18/latex-forge/ci.yml?branch=main&style=for-the-badge" alt="CI"></a>
+  <a href="https://pypi.org/project/latex-forge/"><img src="https://img.shields.io/pypi/pyversions/latex-forge?style=for-the-badge" alt="Python versions"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green?style=for-the-badge" alt="License MIT"></a>
+</p>
+
+<p align="center">
+  <a href="./README.fr.md">Lire en français</a>
+</p>
+
+---
+
+LaTeX Toolbox is a command-line tool that generates ready-to-compile, standalone LaTeX projects from templates. Each generated project embeds its own styles and assets — it can be compiled, shared, and versioned independently, with no dependency on this repository.
+
+## Installation
+
+```bash
+pipx install latex-forge
+```
+
+Requires Python 3.10+. If `pipx` is not installed: `brew install pipx` on macOS, or see [pipx.pypa.io](https://pipx.pypa.io).
+
+## First setup
+
+On a fresh machine, run the setup command to check your environment and install LaTeX automatically:
+
+```bash
+latex-forge setup
+```
+
+This verifies that `latexmk` and `lualatex` are available, and offers to install them via your system package manager (`brew` on macOS, `apt` on Debian/Ubuntu, `winget` on Windows). VS Code extensions are also installed if the `code` CLI is available.
+
+## Profile
+
+Set up your profile once to automatically pre-fill project metadata on every `create`:
+
+```bash
+latex-forge profile --set
+```
+
+```
+Full name: Dupont Alice
+University / school: Université de Bordeaux
+Program / formation: Master Informatique
+GitHub username (optional): dupont-alice
+```
+
+This is offered automatically on first launch. To update it at any time:
+
+```bash
+latex-forge profile        # view current profile
+latex-forge profile --set  # update
+```
+
+Profile values are stored in `~/.latex-forge.toml` and applied to each new project's `frontmatter/metadata.tex`. When a GitHub username is set, it is rendered as a link under your name in the PDF title page.
+
+## Shell completion
+
+Tab completion for commands, flags, and template names. Add one line to your shell config:
+
+**bash** (`~/.bashrc`) or **zsh** (`~/.zshrc`):
+
+```bash
+eval "$(latex-forge completion)"
+```
+
+Reload your shell (`source ~/.zshrc`) or open a new terminal window.
+
+## Configuration
+
+Create `~/.latex-forge.toml` to set default values applied to every command:
+
+```toml
+default_template = "rapport-projet-en"
+default_output_dir = "~/Documents/projects"
+```
+
+| Key | Description |
+|---|---|
+| `default_template` | Template used when `--template` is omitted |
+| `default_output_dir` | Output directory used when `--output` is omitted |
+
+## Usage
+
+### Interactive mode
+
+Run `create` with no arguments to be guided step by step:
+
+```
+$ latex-forge create
+
+Project name: my-report
+Available templates:
+  1. cv-en
+  2. cv-fr
+  3. rapport-projet-en
+  4. rapport-projet-fr
+  5. research
+Choose a template [1-5]: 3
+Create project in [/Users/thomas/Desktop]:
+
+Project created: /Users/thomas/Desktop/my-report
+Edit: my-report/my-report.tex
+Next: fill in frontmatter/metadata.tex then save to compile.
+Open project in VS Code? [y/N]
+```
+
+### With flags
+
+All arguments are optional — omitted ones are prompted interactively.
+
+```bash
+# specify everything upfront
+latex-forge create --name my-report --template rapport-projet-en
+
+# create in a specific directory
+latex-forge create --name my-paper --template research --output ~/Desktop
+```
+
+### Rename a project
+
+```bash
+# from the parent directory
+latex-forge rename old-name new-name
+
+# from inside the project directory
+latex-forge rename new-name
+```
+
+This renames the folder, the main `.tex` file, and any existing build artifacts.
+
+## Available templates
+
+| Template | Language | Description |
+|---|---|---|
+| `rapport-projet-en` | English | ISO/IEEE-aligned project report — requirements, architecture, testing, bibliography, appendices |
+| `rapport-projet-fr` | French | AFNOR/ISO-aligned project report — cahier des charges, architecture, tests, bibliographie, annexes |
+| `research` | English | Research article — two-column layout, related work, methodology, experiments, bibliography |
+| `cv-en` | English | CV / résumé — education, experience, projects, involvement, skills |
+| `cv-fr` | French | CV — formation, expérience, projets, engagement, compétences |
+
+```bash
+latex-forge list-templates
+```
+
+## After creating a project
+
+1. Open the generated folder in VS Code.
+2. Fill in `frontmatter/metadata.tex` — title, authors, course name, university logo.
+3. Save the main `.tex` file to trigger compilation (requires [LaTeX Workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop)).
+4. The PDF is built into `build/`.
+
+Example `metadata.tex`:
+
+```tex
+\newcommand{\reporttitle}{Audio Fingerprinting Study}
+\newcommand{\coursename}{Machine Learning}
+
+\resetauthors
+\addauthor{Alice Martin}{}
+\addauthor{Bob Durand}{}
+
+\resetteachers
+\addteacher{Dr Example}{}
+
+\resetprojectlinks
+\addprojectlink{Repository}{https://github.com/example/project}
+```
+
+Leaving the second argument empty in `\addauthor{...}{}` or `\addteacher{...}{}` hides the role label.
+
+## Generated project structure
+
+```
+my-project/
+├── my-project.tex            ← main file (named after the project)
+├── frontmatter/
+│   ├── metadata.tex          ← title, authors, course
+│   └── toc.tex
+├── sections/
+├── backmatter/
+├── figures/
+├── images/
+├── screens/
+├── assets/
+│   ├── images/common/
+│   └── logos/
+├── styles/packages/          ← embedded styles, no external dependency
+├── scripts/                  ← standalone setup scripts
+├── .vscode/                  ← LaTeX Workshop settings
+└── .gitignore
+```
+
+Styles and logos are copied into the project at creation time. The generated project has no runtime dependency on this repository.
+
+## Command reference
+
+| Command | Description |
+|---|---|
+| `latex-forge create` | Create a project (interactive) |
+| `latex-forge create --name NAME --template TEMPLATE` | Create with explicit arguments |
+| `latex-forge create --output DIR` | Set output directory |
+| `latex-forge rename OLD NEW` | Rename from parent directory |
+| `latex-forge rename NEW` | Rename from inside project directory |
+| `latex-forge list-templates` | List available templates |
+| `latex-forge setup` | Check and set up the LaTeX environment |
+| `latex-forge setup --check-only` | Check without installing anything |
+| `latex-forge setup --install-tex` | Install LaTeX directly |
+| `latex-forge --version` | Show installed version |
+| `latex-forge profile` | View your saved profile |
+| `latex-forge profile --set` | Run interactive profile setup |
+| `latex-forge completion` | Print shell completion setup code |
+
+## Versioning generated projects
+
+Each generated project is self-contained, making it straightforward to version independently:
+
+```bash
+cd my-project
+git init
+git add .
+git commit -m "Initial report"
+```
+
+Create a dedicated private repository and invite only the collaborators relevant to that document.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+Made by [thmsgo18](https://github.com/thmsgo18)

latex_forge-0.2.0/README.md

@@ -0,0 +1,244 @@
+# LaTeX Toolbox
+
+<p align="center">
+  <img src="docs/assets/latex-forge-logo.png" alt="LaTeX Toolbox" width="480">
+</p>
+
+<p align="center">
+  Skip the setup. Start writing. Everything you need, nothing more.
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/latex-forge/"><img src="https://img.shields.io/pypi/v/latex-forge?style=for-the-badge&color=blue" alt="PyPI version"></a>
+  <a href="https://github.com/thmsgo18/latex-forge/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/thmsgo18/latex-forge/ci.yml?branch=main&style=for-the-badge" alt="CI"></a>
+  <a href="https://pypi.org/project/latex-forge/"><img src="https://img.shields.io/pypi/pyversions/latex-forge?style=for-the-badge" alt="Python versions"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green?style=for-the-badge" alt="License MIT"></a>
+</p>
+
+<p align="center">
+  <a href="./README.fr.md">Lire en français</a>
+</p>
+
+---
+
+LaTeX Toolbox is a command-line tool that generates ready-to-compile, standalone LaTeX projects from templates. Each generated project embeds its own styles and assets — it can be compiled, shared, and versioned independently, with no dependency on this repository.
+
+## Installation
+
+```bash
+pipx install latex-forge
+```
+
+Requires Python 3.10+. If `pipx` is not installed: `brew install pipx` on macOS, or see [pipx.pypa.io](https://pipx.pypa.io).
+
+## First setup
+
+On a fresh machine, run the setup command to check your environment and install LaTeX automatically:
+
+```bash
+latex-forge setup
+```
+
+This verifies that `latexmk` and `lualatex` are available, and offers to install them via your system package manager (`brew` on macOS, `apt` on Debian/Ubuntu, `winget` on Windows). VS Code extensions are also installed if the `code` CLI is available.
+
+## Profile
+
+Set up your profile once to automatically pre-fill project metadata on every `create`:
+
+```bash
+latex-forge profile --set
+```
+
+```
+Full name: Dupont Alice
+University / school: Université de Bordeaux
+Program / formation: Master Informatique
+GitHub username (optional): dupont-alice
+```
+
+This is offered automatically on first launch. To update it at any time:
+
+```bash
+latex-forge profile        # view current profile
+latex-forge profile --set  # update
+```
+
+Profile values are stored in `~/.latex-forge.toml` and applied to each new project's `frontmatter/metadata.tex`. When a GitHub username is set, it is rendered as a link under your name in the PDF title page.
+
+## Shell completion
+
+Tab completion for commands, flags, and template names. Add one line to your shell config:
+
+**bash** (`~/.bashrc`) or **zsh** (`~/.zshrc`):
+
+```bash
+eval "$(latex-forge completion)"
+```
+
+Reload your shell (`source ~/.zshrc`) or open a new terminal window.
+
+## Configuration
+
+Create `~/.latex-forge.toml` to set default values applied to every command:
+
+```toml
+default_template = "rapport-projet-en"
+default_output_dir = "~/Documents/projects"
+```
+
+| Key | Description |
+|---|---|
+| `default_template` | Template used when `--template` is omitted |
+| `default_output_dir` | Output directory used when `--output` is omitted |
+
+## Usage
+
+### Interactive mode
+
+Run `create` with no arguments to be guided step by step:
+
+```
+$ latex-forge create
+
+Project name: my-report
+Available templates:
+  1. cv-en
+  2. cv-fr
+  3. rapport-projet-en
+  4. rapport-projet-fr
+  5. research
+Choose a template [1-5]: 3
+Create project in [/Users/thomas/Desktop]:
+
+Project created: /Users/thomas/Desktop/my-report
+Edit: my-report/my-report.tex
+Next: fill in frontmatter/metadata.tex then save to compile.
+Open project in VS Code? [y/N]
+```
+
+### With flags
+
+All arguments are optional — omitted ones are prompted interactively.
+
+```bash
+# specify everything upfront
+latex-forge create --name my-report --template rapport-projet-en
+
+# create in a specific directory
+latex-forge create --name my-paper --template research --output ~/Desktop
+```
+
+### Rename a project
+
+```bash
+# from the parent directory
+latex-forge rename old-name new-name
+
+# from inside the project directory
+latex-forge rename new-name
+```
+
+This renames the folder, the main `.tex` file, and any existing build artifacts.
+
+## Available templates
+
+| Template | Language | Description |
+|---|---|---|
+| `rapport-projet-en` | English | ISO/IEEE-aligned project report — requirements, architecture, testing, bibliography, appendices |
+| `rapport-projet-fr` | French | AFNOR/ISO-aligned project report — cahier des charges, architecture, tests, bibliographie, annexes |
+| `research` | English | Research article — two-column layout, related work, methodology, experiments, bibliography |
+| `cv-en` | English | CV / résumé — education, experience, projects, involvement, skills |
+| `cv-fr` | French | CV — formation, expérience, projets, engagement, compétences |
+
+```bash
+latex-forge list-templates
+```
+
+## After creating a project
+
+1. Open the generated folder in VS Code.
+2. Fill in `frontmatter/metadata.tex` — title, authors, course name, university logo.
+3. Save the main `.tex` file to trigger compilation (requires [LaTeX Workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop)).
+4. The PDF is built into `build/`.
+
+Example `metadata.tex`:
+
+```tex
+\newcommand{\reporttitle}{Audio Fingerprinting Study}
+\newcommand{\coursename}{Machine Learning}
+
+\resetauthors
+\addauthor{Alice Martin}{}
+\addauthor{Bob Durand}{}
+
+\resetteachers
+\addteacher{Dr Example}{}
+
+\resetprojectlinks
+\addprojectlink{Repository}{https://github.com/example/project}
+```
+
+Leaving the second argument empty in `\addauthor{...}{}` or `\addteacher{...}{}` hides the role label.
+
+## Generated project structure
+
+```
+my-project/
+├── my-project.tex            ← main file (named after the project)
+├── frontmatter/
+│   ├── metadata.tex          ← title, authors, course
+│   └── toc.tex
+├── sections/
+├── backmatter/
+├── figures/
+├── images/
+├── screens/
+├── assets/
+│   ├── images/common/
+│   └── logos/
+├── styles/packages/          ← embedded styles, no external dependency
+├── scripts/                  ← standalone setup scripts
+├── .vscode/                  ← LaTeX Workshop settings
+└── .gitignore
+```
+
+Styles and logos are copied into the project at creation time. The generated project has no runtime dependency on this repository.
+
+## Command reference
+
+| Command | Description |
+|---|---|
+| `latex-forge create` | Create a project (interactive) |
+| `latex-forge create --name NAME --template TEMPLATE` | Create with explicit arguments |
+| `latex-forge create --output DIR` | Set output directory |
+| `latex-forge rename OLD NEW` | Rename from parent directory |
+| `latex-forge rename NEW` | Rename from inside project directory |
+| `latex-forge list-templates` | List available templates |
+| `latex-forge setup` | Check and set up the LaTeX environment |
+| `latex-forge setup --check-only` | Check without installing anything |
+| `latex-forge setup --install-tex` | Install LaTeX directly |
+| `latex-forge --version` | Show installed version |
+| `latex-forge profile` | View your saved profile |
+| `latex-forge profile --set` | Run interactive profile setup |
+| `latex-forge completion` | Print shell completion setup code |
+
+## Versioning generated projects
+
+Each generated project is self-contained, making it straightforward to version independently:
+
+```bash
+cd my-project
+git init
+git add .
+git commit -m "Initial report"
+```
+
+Create a dedicated private repository and invite only the collaborators relevant to that document.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+Made by [thmsgo18](https://github.com/thmsgo18)

latex_forge-0.2.0/latex_forge/.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+  "recommendations": [
+    "James-Yu.latex-workshop",
+    "ltex-plus.vscode-ltex-plus",
+    "streetsidesoftware.code-spell-checker",
+    "streetsidesoftware.code-spell-checker-french",
+    "MS-vsliveshare.vsliveshare"
+  ]
+}

latex_forge-0.2.0/latex_forge/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["__version__"]
+
+__version__ = "0.1.0"

latex_forge-0.2.0/latex_forge/assets/images/common/README.md

@@ -0,0 +1,8 @@
+Place ici les PNG, JPG ou PDF que tu reutilises dans plusieurs projets.
+
+Exemples :
+
+- schemas generiques
+- captures d'ecran recurrentes
+- signatures visuelles
+- icones maison

latex_forge-0.2.0/latex_forge/assets/logos/README.md

@@ -0,0 +1,8 @@
+Place ici les logos reutilises entre plusieurs documents.
+
+Exemples :
+
+- logo labo
+- logo entreprise
+- logo universite
+- logo-up-maths-info.jpg pour le template TER IAD/VMI