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

Check difference between two responses of API.
https://github.com/tadashi-aikawa/jumeaux

Last synced: 4 months ago
JSON representation

Check difference between two responses of API.

• Host: GitHub
• URL: https://github.com/tadashi-aikawa/jumeaux
• Owner: tadashi-aikawa
• License: mit
• Created: 2014-11-02T11:14:13.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-05-12T12:12:15.000Z (9 months ago)
• Last Synced: 2024-05-12T13:29:30.831Z (9 months ago)
• Language: Python
• Homepage: https://tadashi-aikawa.github.io/jumeaux/
• Size: 5.33 MB
• Stars: 7
• Watchers: 5
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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)



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

* poetry

* 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

```

$ poetry env use 

$ poetry install

```

#### Run

```

$ poetry run python jumeaux/main.py 

```

#### 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!!!**

* poetry (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.