Metadata-Version: 2.3
Name: pixi-sync-environment
Version: 0.1.2
Summary: Pre-commit hook to sync a pixi environment with a traditional conda environment.yml
Keywords: 
Author: Bernardo Veronese
Author-email: Bernardo Veronese <bernardopveronese@gmail.com>
License: MIT License
         
         Copyright (c) 2025 Bernardo Porto Veronese
         
         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.
Classifier: Programming Language :: Python :: 3
Requires-Dist: pyyaml>=6.0.2
Requires-Python: >=3.10
Project-URL: Homepage, https://github.com/binado/pixi-sync-environment
Description-Content-Type: text/markdown

# pixi-sync-environment

Pre-commit hook to sync a pixi environment with a traditional conda environment.yml.
Useful tool if you want to keep an up-to-date `environment.yml`  in your project.

Easily customize the environment name, prefix, conda channels,
and whether to export pip packages or build names.


## Installation

To use it, register the hook in your `.pre-commit-config.yml`:

```yaml
repos:
  - repo: https://github.com/binado/pixi-sync-environment
    rev: v0.1.0
    hooks:
      - id: pixi-sync-environment
        args: []
```

## Optional arguments:

You may specify additional arguments in the `args` property:

```bash
Compare and update conda environment files using pixi manifest

positional arguments:
  input_files           Path to configuration files
                        (pixi.toml/pyproject.toml/environment.yml/pixi.lock)

options:
  -h, --help            show this help message and exit
  --environment-file ENVIRONMENT_FILE
                        Name of the environment file (default:
                        environment.yml)
  --explicit            Use explicit package specifications (default: False)
  --name NAME           Environment name (optional) (default: None)
  --prefix PREFIX       Environment prefix path (optional) (default: None)
  --environment ENVIRONMENT
                        Name of pixi environment (default: default)
  --include-pip-packages
                        Include pip packages in the environment (default:
                        False)
  --no-include-conda-channels
                        Exclude conda channels from the environment (default:
                        True)
  --include-build       Include build information (default: False)
```
