# Jumeaux
[](https://pypi.org/project/jumeaux/)
[](https://pypi.org/project/jumeaux/)
[](https://github.com/tadashi-aikawa/jumeaux/actions)
[](https://codecov.io/gh/tadashi-aikawa/jumeaux)
[](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
* 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 <path of python 3.12>
$ poetry install
```
#### Run
```
$ poetry run python 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!!!**
* 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.
Raw data
{
"_id": null,
"home_page": "https://tadashi-aikawa.github.io/jumeaux",
"name": "jumeaux",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.0",
"maintainer_email": null,
"keywords": "diff rest api response regression test",
"author": "tadashi-aikawa",
"author_email": "syou.maman@gmail.com",
"download_url": null,
"platform": null,
"description": "# Jumeaux\n\n[](https://pypi.org/project/jumeaux/)\n[](https://pypi.org/project/jumeaux/)\n[](https://github.com/tadashi-aikawa/jumeaux/actions)\n[](https://codecov.io/gh/tadashi-aikawa/jumeaux)\n[](https://github.com/tadashi-aikawa/jumeaux/blob/master/LICENSE)\n\n<img src=\"https://github.com/tadashi-aikawa/jumeaux/blob/master/logo.png?raw=true\" width=400 height=400 />\n\nCheck difference between two responses of API.\n\n## \ud83d\udcda Documentation\n\nhttps://tadashi-aikawa.github.io/jumeaux/\n\nThere is a \ud83c\udfa5demo, too.\n\n\n## \ud83e\udd89 Install\n\nSee [quick start in documentation](https://tadashi-aikawa.github.io/jumeaux/ja/getstarted/quickstart/).\n\n\n## \ud83d\udcbb For developer\n\n### Requirements\n\n* poetry\n* make\n\n### Flow\n\n1. Development on master and if you need branches and issues, create them\n2. Commit with prefix emoji such as \"\ud83d\udcdd\", and suffix issue number like \"#120\"\n\n### Commands\n\n#### Create environment\n\n```\n$ poetry env use <path of python 3.12>\n$ poetry install\n```\n\n#### Run\n\n```\n$ poetry run python jumeaux/main.py <args>\n```\n\n#### Serve docs\n\n```\n$ make serve-docs\n```\n\n#### Unit test\n\n```\n$ make test\n```\n\n#### Integration test\n\n```\n$ make test-e2e\n```\n\n\n\n## \ud83d\udce6 Release\n\n### 1. Update release note (mkdocs/ja/releases/*)\n\n```\n$ git commit -m \"\ud83d\udcdd Update release note\"\n$ git push\n```\n\n### 2. Release with GitHub Actions\n\nhttps://github.com/tadashi-aikawa/jumeaux/actions/workflows/release.yaml?query=workflow%3ARelease\n\n----\n\n### (Appendix) Another way\n\nIf you can't or don't want to use GitHub Actions, you can release locally as following.\n\n#### (a1) Requirements\n\n* **Windows is not supported!!!**\n* poetry (with pypi authentications)\n* make\n\n#### (a2) Commands\n\n```bash\nmake release version=x.y.z\n```\n\n\n## \ud83c\udfab Licence\n\n### MIT\n\nThis software is released under the MIT License, see LICENSE.txt.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Check difference between two responses of API.",
"version": "5.0.1",
"project_urls": {
"Documentation": "https://tadashi-aikawa.github.io/jumeaux",
"Homepage": "https://tadashi-aikawa.github.io/jumeaux",
"Repository": "https://github.com/tadashi-aikawa/jumeaux/blob/master/README.md"
},
"split_keywords": [
"diff",
"rest",
"api",
"response",
"regression",
"test"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8e371ee3730dcdc50dc3e284b06452e7f237a78d119452a9fce65e9aa80712f2",
"md5": "f205e57c3724aecfd04abc9a15b30921",
"sha256": "b8d3ec4f2852eda10f70820ac1b004d1705f322797ecca646658ec1f5e32870a"
},
"downloads": -1,
"filename": "jumeaux-5.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f205e57c3724aecfd04abc9a15b30921",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.0",
"size": 100232,
"upload_time": "2024-05-04T07:14:27",
"upload_time_iso_8601": "2024-05-04T07:14:27.165008Z",
"url": "https://files.pythonhosted.org/packages/8e/37/1ee3730dcdc50dc3e284b06452e7f237a78d119452a9fce65e9aa80712f2/jumeaux-5.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-04 07:14:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tadashi-aikawa",
"github_project": "jumeaux",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "jumeaux"
}
JSON
