Metadata-Version: 2.4
Name: jumeaux
Version: 6.1.0
Summary: Check difference between two responses of API.
Project-URL: homepage, https://tadashi-aikawa.github.io/jumeaux
Project-URL: repository, https://github.com/tadashi-aikawa/jumeaux/blob/master/README.md
Project-URL: documentation, https://tadashi-aikawa.github.io/jumeaux
Author-email: tadashi-aikawa <syou.maman@gmail.com>
License: MIT
License-File: LICENSE
Keywords: diff rest api response regression test
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Testing
Requires-Python: <4.0.0,>=3.10.0
Requires-Dist: beautifulsoup4<5.0.0,>=4.8.1
Requires-Dist: boto3<2.0.0,>=1.10.28
Requires-Dist: deepdiff==8.6.1
Requires-Dist: docopt<1.0.0,>=0.6.2
Requires-Dist: freezegun<2.0.0,>=1.5.1
Requires-Dist: jinja2<4.0.0,>=3.1.2
Requires-Dist: livereload<3.0.0,>=2.6.1
Requires-Dist: lxml<6.0.0,>=5.3.0
Requires-Dist: markupsafe==2.0.1
Requires-Dist: owcli<1.0.0,>=0.8.0
Requires-Dist: owlmixin<8.0.0,>=7.0.1
Requires-Dist: pydash<7.0.0,>=4.7.6
Requires-Dist: requests<3.0.0,>=2.22.0
Requires-Dist: schema<1.0.0,>=0.7.1
Requires-Dist: tzlocal<3.0.0,>=2.0.0
Requires-Dist: urllib3<3,>=2.6.3
Requires-Dist: xmltodict<1.0.0,>=0.12.0
Description-Content-Type: text/markdown

# Jumeaux

[![pypi](https://img.shields.io/pypi/v/jumeaux.svg)](https://pypi.org/project/jumeaux/)
[![Versions](https://img.shields.io/pypi/pyversions/jumeaux.svg)](https://pypi.org/project/jumeaux/)
[![Actions Status](https://github.com/tadashi-aikawa/jumeaux/workflows/Tests/badge.svg)](https://github.com/tadashi-aikawa/jumeaux/actions)
[![codecov](https://codecov.io/gh/tadashi-aikawa/jumeaux/branch/master/graph/badge.svg)](https://codecov.io/gh/tadashi-aikawa/jumeaux)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/tadashi-aikawa/jumeaux/blob/master/LICENSE)

<img src="https://github.com/tadashi-aikawa/jumeaux/blob/master/logo.png?raw=true" width=400 height=400 />

Check difference between two responses of API.

## 📚 Documentation

https://tadashi-aikawa.github.io/jumeaux/

There is a 🎥demo, too.


## 🦉 Install

See [quick start in documentation](https://tadashi-aikawa.github.io/jumeaux/ja/getstarted/quickstart/).


## 💻 For developer

### Requirements

* uv
* make

### Flow

1. Development on master and if you need branches and issues, create them
2. Commit with prefix emoji such as "📝", and suffix issue number like "#120"

### Commands

#### Create environment

```
$ uv sync
```

#### Run

```
$ uv run jumeaux/main.py <args>
```

#### Serve docs

```
$ make serve-docs
```

#### Unit test

```
$ make test
```

#### Integration test

```
$ make test-e2e
```

## 📦 Release

### 1. Update release note (mkdocs/ja/releases/*)

```
$ git commit -m "📝 Update release note"
$ git push
```

### 2. Release with GitHub Actions

https://github.com/tadashi-aikawa/jumeaux/actions/workflows/release.yaml?query=workflow%3ARelease

----

### (Appendix) Another way

If you can't or don't want to use GitHub Actions, you can release locally as following.

#### (a1) Requirements

* **Windows is not supported!!!**
* uv (with pypi authentications)
* make

#### (a2) Commands

```bash
make release version=x.y.z
```


## 🎫 Licence

### MIT

This software is released under the MIT License, see LICENSE.txt.

