article-cli 1.0.0__tar.gz

article_cli-1.0.0/.gitignore

@@ -0,0 +1,142 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Test configurations
+test-config.toml

article_cli-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Christophe Prud'homme
+
+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.

article_cli-1.0.0/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: article-cli
+Version: 1.0.0
+Summary: CLI tool for managing LaTeX articles with git integration and Zotero bibliography
+Project-URL: Homepage, https://github.com/feelpp/article.cli
+Project-URL: Documentation, https://github.com/feelpp/article.cli#readme
+Project-URL: Repository, https://github.com/feelpp/article.cli.git
+Project-URL: Issues, https://github.com/feelpp/article.cli/issues
+Author-email: Christophe Prud'homme <prudhomm@cemosis.fr>
+License: MIT License
+        
+        Copyright (c) 2024 Christophe Prud'homme
+        
+        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.
+License-File: LICENSE
+Keywords: academic,bibliography,git,latex,research,zotero
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Requires-Python: >=3.8
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0; extra == 'dev'
+Requires-Dist: flake8>=6.0; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Article CLI
+
+[![CI](https://github.com/feelpp/article.cli/actions/workflows/ci.yml/badge.svg)](https://github.com/feelpp/article.cli/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/article-cli.svg)](https://badge.fury.io/py/article-cli)
+[![Python Support](https://img.shields.io/pypi/pyversions/article-cli.svg)](https://pypi.org/project/article-cli/)
+
+A command-line tool for managing LaTeX articles with git integration and Zotero bibliography synchronization.
+
+## Features
+
+- **Git Release Management**: Create, list, and delete releases with gitinfo2 support
+- **Zotero Integration**: Synchronize bibliography from Zotero with robust pagination and error handling
+- **LaTeX Build Management**: Clean build files and manage LaTeX compilation artifacts
+- **Git Hooks Setup**: Automated setup of git hooks for gitinfo2 integration
+- **Local Configuration**: Support for project-specific configuration files
+
+## Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install article-cli
+```
+
+### From Source
+
+```bash
+git clone https://github.com/feelpp/article.cli.git
+cd article.cli
+pip install -e .
+```
+
+## Quick Start
+
+1. **Setup git hooks** (run once per repository):
+   ```bash
+   article-cli setup
+   ```
+
+2. **Configure Zotero credentials** (one-time setup):
+   ```bash
+   export ZOTERO_API_KEY="your_api_key_here"
+   export ZOTERO_GROUP_ID="your_group_id"  # or ZOTERO_USER_ID
+   ```
+
+3. **Update bibliography from Zotero**:
+   ```bash
+   article-cli update-bibtex
+   ```
+
+4. **Create a release**:
+   ```bash
+   article-cli create v1.0.0
+   ```
+
+## Configuration
+
+### Environment Variables
+
+- `ZOTERO_API_KEY`: Your Zotero API key (required for bibliography updates)
+- `ZOTERO_USER_ID`: Your Zotero user ID (alternative to group ID)
+- `ZOTERO_GROUP_ID`: Your Zotero group ID (alternative to user ID)
+
+### Local Configuration File
+
+Create a `.article-cli.toml` file in your project root for project-specific settings:
+
+```toml
+[zotero]
+api_key = "your_api_key_here"
+group_id = "6219333"
+# user_id = "your_user_id"  # alternative to group_id
+output_file = "references.bib"
+
+[git]
+auto_push = true
+default_branch = "main"
+
+[latex]
+clean_extensions = [".aux", ".bbl", ".blg", ".log", ".out", ".synctex.gz"]
+```
+
+## Usage
+
+### Git Release Management
+
+```bash
+# Create a new release
+article-cli create v1.2.3
+
+# List recent releases
+article-cli list --count 10
+
+# Delete a release
+article-cli delete v1.2.3
+```
+
+### Bibliography Management
+
+```bash
+# Update bibliography from Zotero
+article-cli update-bibtex
+
+# Specify custom output file
+article-cli update-bibtex --output my-refs.bib
+
+# Skip backup creation
+article-cli update-bibtex --no-backup
+```
+
+### Project Setup
+
+```bash
+# Setup git hooks for gitinfo2
+article-cli setup
+
+# Clean LaTeX build files
+article-cli clean
+```
+
+### Advanced Usage
+
+```bash
+# Override configuration via command line
+article-cli update-bibtex --api-key YOUR_KEY --group-id YOUR_GROUP
+
+# Specify custom configuration file
+article-cli --config custom-config.toml update-bibtex
+```
+
+## Version Format
+
+Release versions must follow the semantic versioning format:
+- `vX.Y.Z` for stable releases (e.g., `v1.2.3`)
+- `vX.Y.Z-pre.N` for pre-releases (e.g., `v1.2.3-pre.1`)
+
+## Requirements
+
+- Python 3.8+
+- Git repository with gitinfo2 package (for LaTeX integration)
+- Zotero account with API access (for bibliography features)
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Changelog
+
+### v1.0.0
+- Initial release
+- Git release management
+- Zotero bibliography synchronization
+- LaTeX build file cleanup
+- Configuration file support

article_cli-1.0.0/README.md

@@ -0,0 +1,162 @@
+# Article CLI
+
+[![CI](https://github.com/feelpp/article.cli/actions/workflows/ci.yml/badge.svg)](https://github.com/feelpp/article.cli/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/article-cli.svg)](https://badge.fury.io/py/article-cli)
+[![Python Support](https://img.shields.io/pypi/pyversions/article-cli.svg)](https://pypi.org/project/article-cli/)
+
+A command-line tool for managing LaTeX articles with git integration and Zotero bibliography synchronization.
+
+## Features
+
+- **Git Release Management**: Create, list, and delete releases with gitinfo2 support
+- **Zotero Integration**: Synchronize bibliography from Zotero with robust pagination and error handling
+- **LaTeX Build Management**: Clean build files and manage LaTeX compilation artifacts
+- **Git Hooks Setup**: Automated setup of git hooks for gitinfo2 integration
+- **Local Configuration**: Support for project-specific configuration files
+
+## Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install article-cli
+```
+
+### From Source
+
+```bash
+git clone https://github.com/feelpp/article.cli.git
+cd article.cli
+pip install -e .
+```
+
+## Quick Start
+
+1. **Setup git hooks** (run once per repository):
+   ```bash
+   article-cli setup
+   ```
+
+2. **Configure Zotero credentials** (one-time setup):
+   ```bash
+   export ZOTERO_API_KEY="your_api_key_here"
+   export ZOTERO_GROUP_ID="your_group_id"  # or ZOTERO_USER_ID
+   ```
+
+3. **Update bibliography from Zotero**:
+   ```bash
+   article-cli update-bibtex
+   ```
+
+4. **Create a release**:
+   ```bash
+   article-cli create v1.0.0
+   ```
+
+## Configuration
+
+### Environment Variables
+
+- `ZOTERO_API_KEY`: Your Zotero API key (required for bibliography updates)
+- `ZOTERO_USER_ID`: Your Zotero user ID (alternative to group ID)
+- `ZOTERO_GROUP_ID`: Your Zotero group ID (alternative to user ID)
+
+### Local Configuration File
+
+Create a `.article-cli.toml` file in your project root for project-specific settings:
+
+```toml
+[zotero]
+api_key = "your_api_key_here"
+group_id = "6219333"
+# user_id = "your_user_id"  # alternative to group_id
+output_file = "references.bib"
+
+[git]
+auto_push = true
+default_branch = "main"
+
+[latex]
+clean_extensions = [".aux", ".bbl", ".blg", ".log", ".out", ".synctex.gz"]
+```
+
+## Usage
+
+### Git Release Management
+
+```bash
+# Create a new release
+article-cli create v1.2.3
+
+# List recent releases
+article-cli list --count 10
+
+# Delete a release
+article-cli delete v1.2.3
+```
+
+### Bibliography Management
+
+```bash
+# Update bibliography from Zotero
+article-cli update-bibtex
+
+# Specify custom output file
+article-cli update-bibtex --output my-refs.bib
+
+# Skip backup creation
+article-cli update-bibtex --no-backup
+```
+
+### Project Setup
+
+```bash
+# Setup git hooks for gitinfo2
+article-cli setup
+
+# Clean LaTeX build files
+article-cli clean
+```
+
+### Advanced Usage
+
+```bash
+# Override configuration via command line
+article-cli update-bibtex --api-key YOUR_KEY --group-id YOUR_GROUP
+
+# Specify custom configuration file
+article-cli --config custom-config.toml update-bibtex
+```
+
+## Version Format
+
+Release versions must follow the semantic versioning format:
+- `vX.Y.Z` for stable releases (e.g., `v1.2.3`)
+- `vX.Y.Z-pre.N` for pre-releases (e.g., `v1.2.3-pre.1`)
+
+## Requirements
+
+- Python 3.8+
+- Git repository with gitinfo2 package (for LaTeX integration)
+- Zotero account with API access (for bibliography features)
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Changelog
+
+### v1.0.0
+- Initial release
+- Git release management
+- Zotero bibliography synchronization
+- LaTeX build file cleanup
+- Configuration file support

article_cli-1.0.0/pyproject.toml

@@ -0,0 +1,104 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "article-cli"
+version = "1.0.0"
+authors = [
+    {name = "Christophe Prud'homme", email = "prudhomm@cemosis.fr"},
+]
+description = "CLI tool for managing LaTeX articles with git integration and Zotero bibliography"
+readme = "README.md"
+license = {file = "LICENSE"}
+requires-python = ">=3.8"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Text Processing :: Markup :: LaTeX",
+]
+keywords = ["latex", "git", "zotero", "bibliography", "academic", "research"]
+dependencies = [
+    "requests>=2.28.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov",
+    "black>=23.0",
+    "flake8>=6.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/feelpp/article.cli"
+Documentation = "https://github.com/feelpp/article.cli#readme"
+Repository = "https://github.com/feelpp/article.cli.git"
+Issues = "https://github.com/feelpp/article.cli/issues"
+
+[project.scripts]
+article-cli = "article_cli.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/article_cli"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/LICENSE",
+]
+
+[tool.black]
+line-length = 88
+target-version = ['py38']
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # directories
+  \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | build
+  | dist
+)/
+'''
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+strict_equality = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+    "--verbose",
+]

article_cli-1.0.0/src/article_cli/__init__.py

@@ -0,0 +1,20 @@
+"""
+Article CLI - A command-line tool for managing LaTeX articles
+
+This package provides tools for:
+- Git release management with gitinfo2 support
+- Zotero bibliography synchronization
+- LaTeX build file cleanup
+- Git hooks setup
+"""
+
+__version__ = "1.0.0"
+__author__ = "Christophe Prud'homme"
+__email__ = "prudhomm@cemosis.fr"
+
+from .cli import main
+from .config import Config
+from .zotero import ZoteroBibTexUpdater
+from .git_manager import GitManager
+
+__all__ = ["main", "Config", "ZoteroBibTexUpdater", "GitManager"]

article_cli-1.0.0/src/article_cli/__main__.py

@@ -0,0 +1,8 @@
+"""
+Allow running article-cli as a module with python -m article_cli
+"""
+
+from .cli import main
+
+if __name__ == "__main__":
+    main()