Metadata-Version: 2.4
Name: mepo
Version: 2.5.0
Summary: A tool for managing (m)ultiple r(epo)s
Project-URL: Repository, https://github.com/GEOS-ESM/mepo
Author-email: GMAO SI Team <siteam@gmao.gsfc.nasa.gov>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 
        
        1. Definitions.
        
           "License" shall mean the terms and conditions for use, reproduction, and
           distribution as defined by Sections 1 through 9 of this document.
        
           "Licensor" shall mean the copyright owner or entity authorized by the copyright
           owner that is granting the License.
        
           "Legal Entity" shall mean the union of the acting entity and all other entities
           that control, are controlled by, or are under common control with that entity.
           For the purposes of this definition, "control" means (i) the power, direct or
           indirect, to cause the direction or management of such entity, whether by
           contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
           outstanding shares, or (iii) beneficial ownership of such entity.
        
           "You" (or "Your") shall mean an individual or Legal Entity exercising
           permissions granted by this License.
        
           "Source" form shall mean the preferred form for making modifications, including
           but not limited to software source code, documentation source, and configuration
           files.
        
           "Object" form shall mean any form resulting from mechanical transformation or
           translation of a Source form, including but not limited to compiled object code,
           generated documentation, and conversions to other media types.
        
           "Work" shall mean the work of authorship, whether in Source or Object form, made
           available under the License, as indicated by a copyright notice that is included
           in or attached to the work (an example is provided in the Appendix below).
        
           "Derivative Works" shall mean any work, whether in Source or Object form, that
           is based on (or derived from) the Work and for which the editorial revisions,
           annotations, elaborations, or other modifications represent, as a whole, an
           original work of authorship. For the purposes of this License, Derivative Works
           shall not include works that remain separable from, or merely link (or bind by
           name) to the interfaces of, the Work and Derivative Works thereof.
        
           "Contribution" shall mean any work of authorship, including the original version
           of the Work and any modifications or additions to that Work or Derivative Works
           thereof, that is intentionally submitted to Licensor for inclusion in the Work
           by the copyright owner or by an individual or Legal Entity authorized to submit
           on behalf of the copyright owner. For the purposes of this definition,
           "submitted" means any form of electronic, verbal, or written communication sent
           to the Licensor or its representatives, including but not limited to
           communication on electronic mailing lists, source code control systems, and
           issue tracking systems that are managed by, or on behalf of, the Licensor for
           the purpose of discussing and improving the Work, but excluding communication
           that is conspicuously marked or otherwise designated in writing by the copyright
           owner as "Not a Contribution."
        
           "Contributor" shall mean Licensor and any individual or Legal Entity on behalf
           of whom a Contribution has been received by Licensor and subsequently
           incorporated within the Work.
        
        2. Grant of Copyright License.
        
           Subject to the terms and conditions of this License, each Contributor hereby
           grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
           irrevocable copyright license to reproduce, prepare Derivative Works of,
           publicly display, publicly perform, sublicense, and distribute the Work and such
           Derivative Works in Source or Object form.
        
        3. Grant of Patent License.
        
           Subject to the terms and conditions of this License, each Contributor hereby
           grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
           irrevocable (except as stated in this section) patent license to make, have
           made, use, offer to sell, sell, import, and otherwise transfer the Work, where
           such license applies only to those patent claims licensable by such Contributor
           that are necessarily infringed by their Contribution(s) alone or by combination
           of their Contribution(s) with the Work to which such Contribution(s) was
           submitted. If You institute patent litigation against any entity (including a
           cross-claim or counterclaim in a lawsuit) alleging that the Work or a
           Contribution incorporated within the Work constitutes direct or contributory
           patent infringement, then any patent licenses granted to You under this License
           for that Work shall terminate as of the date such litigation is filed.
        
        4. Redistribution.
         
           You may reproduce and distribute copies of the Work or Derivative Works
           thereof in any medium, with or without modifications, and in Source or Object
           form, provided that You meet the following conditions:
        
           (a) You must give any other recipients of the Work or Derivative Works a
              copy of this License; and
        
           (b) You must cause any modified files to carry prominent notices stating that
              You changed the files; and
        
           (c) You must retain, in the Source form of any Derivative Works that You
              distribute, all copyright, patent, trademark, and attribution notices from
              the Source form of the Work, excluding those notices that do not pertain
              to any part of the Derivative Works; and
        
           (d) If the Work includes a "NOTICE" text file as part of its distribution,
              then any Derivative Works that You distribute must include a readable copy
              of the attribution notices contained within such NOTICE file, excluding
              those notices that do not pertain to any part of the Derivative Works, in
              at least one of the following places: within a NOTICE text file
              distributed as part of the Derivative Works; within the Source form or
              documentation, if provided along with the Derivative Works; or, within a
              display generated by the Derivative Works, if and wherever such
              third-party notices normally appear. The contents of the NOTICE file are
              for informational purposes only and do not modify the License. You may add
              Your own attribution notices within Derivative Works that You distribute,
              alongside or as an addendum to the NOTICE text from the Work, provided
              that such additional attribution notices cannot be construed as modifying
              the License.
           
           You may add Your own copyright statement to Your modifications and may
           provide additional or different license terms and conditions for use,
           reproduction, or distribution of Your modifications, or for any such
           Derivative Works as a whole, provided Your use, reproduction, and
           distribution of the Work otherwise complies with the conditions stated in
           this License.
        
        5. Submission of Contributions.
        
           Unless You explicitly state otherwise, any Contribution intentionally
           submitted for inclusion in the Work by You to the Licensor shall be under the
           terms and conditions of this License, without any additional terms or
           conditions. Notwithstanding the above, nothing herein shall supersede or
           modify the terms of any separate license agreement you may have executed with
           Licensor regarding such Contributions.
        
        6. Trademarks.
        
           This License does not grant permission to use the trade names, trademarks,
           service marks, or product names of the Licensor, except as required for
           reasonable and customary use in describing the origin of the Work and
           reproducing the content of the NOTICE file.
        
        7. Disclaimer of Warranty.
        
           Unless required by applicable law or agreed to in writing, Licensor provides
           the Work (and each Contributor provides its Contributions) on an "AS IS"
           BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
           implied, including, without limitation, any warranties or conditions of
           TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR
           PURPOSE. You are solely responsible for determining the appropriateness of
           using or redistributing the Work and assume any risks associated with Your
           exercise of permissions under this License.
        
        8. Limitation of Liability.
        
           In no event and under no legal theory, whether in tort (including
           negligence), contract, or otherwise, unless required by applicable law (such
           as deliberate and grossly negligent acts) or agreed to in writing, shall any
           Contributor be liable to You for damages, including any direct, indirect,
           special, incidental, or consequential damages of any character arising as a
           result of this License or out of the use or inability to use the Work
           (including but not limited to damages for loss of goodwill, work stoppage,
           computer failure or malfunction, or any and all other commercial damages or
           losses), even if such Contributor has been advised of the possibility of such
           damages.
        
        9. Accepting Warranty or Additional Liability.
        
           While redistributing the Work or Derivative Works thereof, You may choose to
           offer, and charge a fee for, acceptance of support, warranty, indemnity, or
           other liability obligations and/or rights consistent with this License.
           However, in accepting such obligations, You may act only on Your own behalf
           and on Your sole responsibility, not on behalf of any other Contributor, and
           only if You agree to indemnify, defend, and hold each Contributor harmless
           for any liability incurred by, or claims asserted against, such Contributor
           by reason of your accepting any such warranty or additional liability.
        
        END OF TERMS AND CONDITIONS
        
        APPENDIX: How to apply the Apache License to your work
        
        To apply the Apache License to your work, attach the following boilerplate
        notice with the fields enclosed by brackets "[]" replaced with your own
        identifying information. (Don't include the brackets!) The text should be
        enclosed in the appropriate comment syntax for the file format. We also
        recommend that a file or class name and description of purpose be included on
        the same "printed page" as the copyright notice for easier identification within
        third-party archives.
        
           NASA Docket No. GSC-15,354-1, and identified as "GEOS-5 GCM Modeling Software”
           
           “Copyright © 2008 United States Government as represented by the Administrator
           of the National Aeronautics and Space Administration. All Rights Reserved.”
           
           Licensed under the Apache License, Version 2.0 (the "License"); you may not use
           this file except in compliance with the License. You may obtain a copy of the
           License at
           
           http://www.apache.org/licenses/LICENSE-2.0
           
           Unless required by applicable law or agreed to in writing, software distributed
           under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
           CONDITIONS OF ANY KIND, either express or implied. See the License for the
           specific language governing permissions and limitations under the License.
License-File: LICENSE
License-File: LICENSE-NOSA
Requires-Python: >=3.9
Requires-Dist: colorama>=0.4.6
Requires-Dist: pyyaml>=6.0.1
Description-Content-Type: text/markdown

# mepo [![Actions Status](https://github.com/pchakraborty/mepo/workflows/Unit%20testing%20of%20mepo/badge.svg)](https://github.com/pchakraborty/mepo/actions) [![DOI](https://zenodo.org/badge/215067850.svg)](https://zenodo.org/badge/latestdoi/215067850) [![Rye](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/rye/main/artwork/badge.json)](https://rye-up.com) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/GEOS-ESM/mepo)

`mepo` is a tool, written in Python3, to manage (m)ultiple git r(epo)sitories, by attempting to create an illusion of a 'single repository' for multi-repository projects. Please see the [Wiki](../../wiki) for examples of `mepo` workflows.


## Installation

### Using pip

To install `mepo` using `pip`, run the following command:

```
pip install mepo
```

### Using uv

#### uv install

You can install `mepo` using the `uv` package manager. To do so, run the following command:

```
uv tool install mepo
```

#### uvx

If you'd like to run `mepo` without installing it, you can use `uvx` to run it directly:

```
uvx mepo
```

### Homebrew

`mepo` is available from the GMAO-SI-Team Homebrew tap:

```sh
brew install gmao-si-team/packages/mepo
```

This direct install form is recommended because it tells Homebrew exactly which formula from the tap you want to install.

#### Homebrew tap trust

Newer Homebrew versions warn about formulae from non-official taps. If you enable tap trust checks, or when Homebrew begins requiring them by default, you may need to explicitly trust this formula or tap.

To trust only the `mepo` formula:

```sh
brew trust --formula gmao-si-team/packages/mepo
```

If you prefer to tap the repository first and then install by short name:

```sh
brew tap gmao-si-team/packages
brew trust gmao-si-team/packages
brew install mepo
```

Only run `brew trust` for taps or formulae whose maintainers and source repository you trust. To remove the tap later:

```sh
brew untap gmao-si-team/packages
```

### Spack

Mepo is also available via spack as a package. To install mepo using spack, run the following command:

```
spack install mepo
```

## Transitioning from `mepo` v1.x to v2.x

If you try to use mepo v2.x within a mepo v1.x repository, you will get an warning message:
```
Detected mepo1 style state
Run <mepo update-state> to permanently convert to mepo2 style
```

To update your repository to work with mepo v2.x, you can run the following command:
```
mepo update-state
```
and it will convert the repository from mepo v1 pickle-state to mepo v2 json-state.

## Commands

For more about the possible `mepo` commands, please see the [Mepo Commands](https://github.com/GEOS-ESM/mepo/wiki/Mepo-Commands) wiki page.

## Presentation

The SI Team has made a PowerPoint about `mepo` that can be found [here](https://github.com/GEOS-ESM/mepo/wiki/files/MEPO-2020Nov19.pptx).

## Contributing

Please check out our [contributing guidelines](CONTRIBUTING.md).

## License

All files are currently licensed under the Apache-2.0 license, see [`LICENSE`](LICENSE).

Previously, the code was licensed under the [NASA Open Source Agreement, Version 1.3](LICENSE-NOSA).
