Metadata-Version: 2.4
Name: conda_index
Version: 0.10.0
Dynamic: Summary
Project-URL: Home, https://github.com/conda/conda-index
Author-email: "Anaconda, Inc. & Contributors" <conda@continuum.io>
License: BSD 3-Clause License
        
        Copyright (c) 2022, conda
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: AUTHORS.md
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: click>=8
Requires-Dist: conda-package-streaming>=0.7.0
Requires-Dist: filelock
Requires-Dist: jinja2
Requires-Dist: msgpack
Requires-Dist: ruamel-yaml
Requires-Dist: zstandard
Provides-Extra: docs
Requires-Dist: furo; extra == 'docs'
Requires-Dist: mdit-py-plugins>=0.3.0; extra == 'docs'
Requires-Dist: myst-parser; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-click; extra == 'docs'
Provides-Extra: test
Requires-Dist: conda-package-handling>=2; extra == 'test'
Requires-Dist: fsspec[http]; extra == 'test'
Requires-Dist: pytest-mock; extra == 'test'
Requires-Dist: pytest>=7; extra == 'test'
Description-Content-Type: text/markdown

# conda-index

`conda-index` creates conda channels from a collection of conda packages.

The `conda_index` command operates on a channel directory. A channel directory
can't be named after a supported platform and must contain a `noarch`
subdirectory. It will usually contain other subdirectories named for conda's
supported platforms `linux-64`, `win-64`, `osx-64`, etc. Place packages into
their corresponding subdirectories. Then run conda-index to extract metadata
from these packages to generate `index.html`, `repodata.json` etc. with
summaries of the packages' metadata. `conda` uses the metadata to solve
dependencies before doing an install.

By default the metadata is output to the same directory tree as the channel
directory but it can be output to a separate tree with the `--output <output>`
parameter. The metadata cache is placed with the packages, in `.cache` folders
under each platform subdirectory.

After `conda-index` has finished, its output can be used as a channel `conda
install -c file:///path/to/output ...` or would typically be placed on a web
server.

## Run normally

```sh
python -m conda_index <path to channel directory>
```
An equivalent `conda` subcommand, `conda index`, is also available.

## Run for debugging

```sh
python -m conda_index --verbose --threads=1 <path to channel directory>
```

## Contributing

```sh
conda create -n conda-index "python >=3.9" conda conda-build "pip >=22"

git clone https://github.com/conda/conda-index.git
pip install -e conda-index[test]

cd conda-index
pytest
```

## Parallelism

This version of conda-index continues indexing packages from other subdirs while
the main thread is writing `repodata.json`.

All `current_repodata.json` are generated in parallel. This may use a lot of ram
if `repodata.json` has tens of thousands of entries.
