Metadata-Version: 2.1
Name: menuinst
Version: 2.1.0
Summary: cross platform install of menu items
License: (c) 2016 Continuum Analytics, Inc. / http://continuum.io
        All Rights Reserved
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
            * Redistributions of source code must retain the above copyright
              notice, this list of conditions and the following disclaimer.
            * 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.
            * Neither the name of Continuum Analytics, Inc. 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 CONTINUUM ANALYTICS 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.
        
Project-URL: repository, https://github.com/conda/menuinst
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
License-File: AUTHORS.md

# menuinst: cross platform menu item installation

This package provides cross platform menu item installation for `conda` packages.

If a conda package ships a [menuinst JSON document][reference] under `$PREFIX/Menu`, `conda` will invoke
`menuinst` to process the JSON file and install the menu items in your operating system.
The menu items are removed when the package is uninstalled.

The following formats are supported:

- Windows: `.lnk` files in the Start menu. Optionally, also in the Desktop and Quick Launch.
- macOS: `.app` bundles in the Applications folder.
- Linux: `.desktop` files as defined in the XDG standard.

## Documentation

Documentation is available at https://conda.github.io/menuinst/.

## History

This package was originally developed and maintained by Enthought under the name AppInst. The name
appinst is a rename of what used to be called 'wininst'.

`menuinst` v1 was only supported on Windows.  Legacy code existed in v1 for Linux and OS X - use at your own risk.  It may mess up your menus.

`menuinst` v2 is a backwards-compatible rewrite to address cross-platform compatibility under a
unified JSON schema, as discussed in [CEP-11][CEP-11]. The Windows bits of the v1 code are still
available under the `menuinst._legacy` subpackage.

## Build status

| [![Build status](https://github.com/conda/menuinst/actions/workflows/tests.yml/badge.svg)](https://github.com/conda/menuinst/actions/workflows/tests.yml) [![Docs status](https://github.com/conda/menuinst/actions/workflows/docs.yml/badge.svg)](https://github.com/conda/menuinst/actions/workflows/docs.yml) [![codecov](https://codecov.io/gh/conda/menuinst/branch/main/graph/badge.svg)](https://codecov.io/gh/conda/menuinst) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/conda/menuinst/main.svg)](https://results.pre-commit.ci/latest/github/conda/menuinst/main)  | [![Anaconda-Server Badge](https://anaconda.org/conda-canary/menuinst/badges/latest_release_date.svg)](https://anaconda.org/conda-canary/menuinst) |
| --- | :-: |
| [`conda install defaults::menuinst`](https://anaconda.org/anaconda/menuinst) | [![Anaconda-Server Badge](https://anaconda.org/anaconda/menuinst/badges/version.svg)](https://anaconda.org/anaconda/menuinst) |
| [`conda install conda-forge::menuinst`](https://anaconda.org/conda-forge/menuinst) | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/menuinst/badges/version.svg)](https://anaconda.org/conda-forge/menuinst) |
| [`conda install conda-canary/label/dev::menuinst`](https://anaconda.org/conda-canary/menuinst) | [![Anaconda-Server Badge](https://anaconda.org/conda-canary/menuinst/badges/version.svg)](https://anaconda.org/conda-canary/menuinst) |

[CEP-11]: https://github.com/conda-incubator/ceps/blob/3da0fb0ece/cep-11.md
[reference]: https://conda.github.io/menuinst/reference/