| Name | jumeaux JSON |
| Version |
6.0.0
JSON |
| download |
| home_page | None |
| Summary | Check difference between two responses of API. |
| upload_time | 2025-01-04 04:33:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0.0,>=3.9.0 |
| license | MIT |
| keywords |
diff
rest
api
response
regression
test
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# 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
* 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "jumeaux",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.9.0",
"maintainer_email": null,
"keywords": "diff rest api response regression test",
"author": null,
"author_email": "tadashi-aikawa <syou.maman@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8b/dd/da675892a6ae69de22c864baf4f6760e7d5110e1f3f193285251e043668d/jumeaux-6.0.0.tar.gz",
"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* uv\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$ uv sync\n```\n\n#### Run\n\n```\n$ uv run 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## \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* uv (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": "6.0.0",
"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": null,
"digests": {
"blake2b_256": "21241d8440be24d27b411da09e92cb6d0e2c580f39ac92a37eb71fc31a36153c",
"md5": "08819ea0701225a6b1a7359b61ef5511",
"sha256": "e2e156cf8c26f2837879b747f4b1a7f8abe2972ab5a579c3a9530bc1f517dc00"
},
"downloads": -1,
"filename": "jumeaux-6.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "08819ea0701225a6b1a7359b61ef5511",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.9.0",
"size": 100165,
"upload_time": "2025-01-04T04:33:24",
"upload_time_iso_8601": "2025-01-04T04:33:24.080719Z",
"url": "https://files.pythonhosted.org/packages/21/24/1d8440be24d27b411da09e92cb6d0e2c580f39ac92a37eb71fc31a36153c/jumeaux-6.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8bddda675892a6ae69de22c864baf4f6760e7d5110e1f3f193285251e043668d",
"md5": "9e435b34044f84d2b7729ad1067f867d",
"sha256": "dd1d9d4a719e221543c77cc32ae07957db6b068aead95a81cfffd3b91956b881"
},
"downloads": -1,
"filename": "jumeaux-6.0.0.tar.gz",
"has_sig": false,
"md5_digest": "9e435b34044f84d2b7729ad1067f867d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.9.0",
"size": 1528019,
"upload_time": "2025-01-04T04:33:25",
"upload_time_iso_8601": "2025-01-04T04:33:25.712887Z",
"url": "https://files.pythonhosted.org/packages/8b/dd/da675892a6ae69de22c864baf4f6760e7d5110e1f3f193285251e043668d/jumeaux-6.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-04 04:33:25",
"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"
}
