| Name | imediff JSON |
| Version |
2.9
JSON |
| download |
| home_page | |
| Summary | 2-way/3-way merge tool (CLI, Ncurses) |
| upload_time | 2024-02-17 14:26:34 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. |
| keywords |
imediff
merge
diff
cli
ncurses
git-ime
ime
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# IMEDIFF - 2-way/3-way merge tool (CLI, Ncurses)
* Copyright (C) 2003,2004 Jarno Elonen <elonen@iki.fi>
* Copyright (C) 2018-2024 Osamu Aoki <osamu@debian.org>
Released under the GNU General Public License, 2.0+.
See LICENSE for details
The latest upstream source: https://github.com/osamuaoki/imediff
This provides the imediff command and git-ime command.
## What is imediff
The imediff command helps you to merge 2 slightly different files with an
optional base file interactively or non-interactively.
For non-interactive 2-way diff operation, this can express diffs with ordinary
diff-format
```console
$ imediff -n older.txt newer.txt -o diff.txt
```
For non-interactive 2-way diff operation, this can also express diffs with
wdiff format
```console
$ imediff -n -f older.txt newer.txt -o wdiff.txt
```
For non-interactive 3-way merge operation, this can not only express conflicts
with ordinary diff3-format but also 3-way wdiff format
```console
$ imediff -n yours.txt base.txt theirs.txt -o merged.txt
$ imediff -n -f yours.txt base.txt theirs.txt -o wdiff-merged.txt
```
Here, this 3-way-merge logic is smarter than "diff3 -m".
For interactive operation, this uses the in-place alternating display of the
changed content on a single-pane full screen terminal user interface. The
source of line is clearly identified by the color of the line or the identifier
character at the first column. The advantage of this user interface is the
minimal movement of the line of sight for the user.
For interactive 2-way pick operation, this can select sections from input
files.
```console
$ imediff older.txt newer.txt -o picked.txt
```
For interactive 3-way merge operation, this can select sections from input
files.
```console
$ imediff yours.txt base.txt theirs.txt -o merged.txt
```
The line matching logic of imediff has been improved to ignore whitespaces and
use partial line matches to provide the best presentation with small chunk of
lines.
The automatic 3 way merge logic of the imediff command operates not only on the
difference by line but on the difference by character. This is another great
feature of the imediff command. So for the non-overlapping changes, it always
yields the clean merge.
You can also use the imediff command non-interactively from CLI with --macro
option.
NOTE: There seems to be some limitation (16K?) of acceptable input lines for
imediff program running under full screen. This causes imediff to crash. The
root cause seems to be the underlining ncurses binding which imediff uses.
## What is git-ime
The "git ime" command helps you to unsquash 2 consecutive commits (`HEAD^`,
`HEAD`) of a git repository. The "`git rebase -i <treeish>`" and "`gitk`" can
be used to organize unsquashed changes.
If any staged changes or local uncommitted changes are found in the git
repository, "git ime" immediately exits without changes to be on the safe side.
If the latest commit involves multiple files, "git ime" splits this big commit
by the file into multiple smaller commits involving a single file for each
commit.
If the latest commit involves only a single file, the commit may be split into
multiple smaller commits involving a set of minimal partial changes. If the
target file is small, splitting process may be managed interactively by
imediff. (You can force non-interactive splitting by "-a" option.)
This "git ime" is not only useful at the checked out branch head but also at
"edit" prompt during the interactive execution of "`git rebase -i <treeish>`".
Execute "git ime" after committing the pending commit.
## Quick start for Debian/Ubuntu derivative users
Please install the `imediff` package from the APT repository.
At the console command line prompt, type:
* "imediff" to read the tutorial,
* "imediff -h" to get all the command line options,
* "imediff -o output older newer" to merge 2 files, and
* "imediff -o output yours base theirs" to merge 3 files.
For usage instructions, type "h" and "H" in the interactive display.
(The use of GNU gettext is disabled for the sake of portability.)
## History and features
This was originally written by Jarno Elonen in Python2. The latest original
upstream version was 1.1.2 released on 2007-8-18.
The original author's website was https://elonen.iki.fi/code/imediff/ . Now it
redirects to this site https://github.com/osamuaoki/imediff .
Osamu Aoki made a minor patched release for Debian buster in Oct 2018.
* No more surprise hitting "q". You will be asked. (Fix Debian bug #799865)
* Fix manpage generation issue (Fix Debian bug #860351)
* New git-ime wrapper script (great for git rebase/un-squash commit)
* You can customize key bindings.
Osamu also wanted to add some features:
* Use of Python3 with pyproject.toml and setuptools to organize the source
into a module with multiple source files.
* Use standard libraries for the flexible customization (argparse,
configparser, logging)
* Addition of diff3 merge capability
* Addition of wdiff capability
* Addition of cursor location display capability
* Make it edit highlighted section only
* Make its TUI more friendly under monochrome terminal
* Use curses.wrapper()
* CLI and logging interface for easy self-testing/debugging
* Add decent test cases
* Include simple tutorial within "imediff".
* Add "git-mergetool" integration.
* Add "git-ime" to help making partial patch series commits to git.
* Good CJK wide character support with East_Asian_Width on console.
This was accomplished by practically a whole rewrite of the source code in
November-December 2018. Osamu decided to release this as imediff after
consulting with Jarno Elonen. Now program name is without "2", since it
supports diff for not only 2 files but also 3 files. The version number is
bumped to 2.0. In version 2.5, line matching rules are updated to produce
better diff presentation.
## Package installation
### Deb-package
You can install `imediff` package on Debian, Ubuntu, and derivatives.
This provides `imediff` and `git-ime` commands.
### Wheel-package
You can install wheel package from https://pypi.org/project/imediff/
After installation of wheel package as a user, you need to run:
```console
$ imediff_install
```
This installs `git-ime` shell command to the pertinent virtual environment etc.
## Note to developer and translator
### Building package
* The building of deb-package is from "debian" branch.
* The building of wheel-package is supported from "main" branch.
You must have a relatively new system with python 3.9 equivalent of Debian 12.0
(bookworm) released on June 10th, 2023 with:
* https://github.com/pypa/setuptools (>=61.0.0)
* https://github.com/pypa/installer/
* https://github.com/pypa/build
* https://github.com/hukkin/tomli
```console
$ cd /path/to/source-root
... hack
$ python3 -m build
$ cd build
$ pip install
```
The building of rpm is not supported as out-of-box now (patch welcome).
Code is not written for Windows compatibility in mind, yet. Gettext support was
intentionally dropped in favor of better compatibility across various systems.
The `git-ime` command requires you to have some POSIX shell and the `git`
command access.
### making Debian package
You can make your own Debian package as:
```console
$ git clone https://github.com/osamuaoki/imediff.git
$ cd imediff
$ git checkout main
... hack source
$ git commit -a
$ rm -rf debian
$ git add -A .
$ git commit
$ git tag 2.5
$ git reset --hard HEAD^
$ git deborig # to make ../*.orig.tar.xz
$ sbuild
$ cd ..
$ sudo dpkg -i imediff_2.5-1_all.deb
```
Here, we assume the upstream version to be 2.5, and the Debian revision to be
1.
If you have bug fixes or feature enhancement propose changes to me via "pull
request"
### updating python source
Please make sure to fit each code below 80-88 chars. (Run "black" on python
code) In case if reformat errors, check its syntax by:
```console
$ python3 -m py_compile program.py
```
### updating manpages
Manpages need to be updated from XML files with "make" first in doc/ directory
when you edit it.
If you wish to update manpage from XML, `docbook-xsl` and `xsltproc` are needed
for building manpage from xml source then manually touch up details.
### testing python source
Whenever you make changes, please test them.
To test the installed module, invoke the test script as:
```console
$ cd /path/to/source-root
$ export PYTHONPATH=$(pwd)/src/
$ python3 test/test_unittest_all.py -v
```
To test the installed module, invoke the test script as:
```console
$ cd /path/to/source-root
$ python3 test/test_unittest_all.py -v
```
## Note on Debian package links
* imediff2 (based on older python2 source for and before stretch)
* https://tracker.debian.org/pkg/imediff2
* https://packages.debian.org/source/sid/imediff2 (source package in Debian)
* https://packages.debian.org/sid/imediff2 (binary package in Debian)
* https://bugs.debian.org/cgi-bin/pkgreport.cgi?repeatmerged=0;src=imediff2 (BTS)
* imediff: (based on newer python3 source for buster)
* https://tracker.debian.org/pkg/imediff
* https://packages.debian.org/source/sid/imediff (source package in Debian)
* https://packages.debian.org/sid/imediff (binary package in Debian)
* https://bugs.debian.org/cgi-bin/pkgreport.cgi?repeatmerged=0;src=imediff (BTS)
This is written and updated by Osamu Aoki on February 2024.
Raw data
{
"_id": null,
"home_page": "",
"name": "imediff",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Osamu Aoki <osamu@debian.org>",
"keywords": "imediff,merge,diff,cli,ncurses,git-ime,ime",
"author": "",
"author_email": "Osamu Aoki <osamu@debian.org>, Jarno Elonen <elonen@iki.fi>",
"download_url": "https://files.pythonhosted.org/packages/05/cb/fc39a679fb31c98531f9e1da906e521d6f80cb5123c76cf0521f121fbe06/imediff-2.9.tar.gz",
"platform": null,
"description": "# IMEDIFF - 2-way/3-way merge tool (CLI, Ncurses)\n\n* Copyright (C) 2003,2004 Jarno Elonen <elonen@iki.fi>\n* Copyright (C) 2018-2024 Osamu Aoki <osamu@debian.org>\n\nReleased under the GNU General Public License, 2.0+.\nSee LICENSE for details\n\nThe latest upstream source: https://github.com/osamuaoki/imediff\n\nThis provides the imediff command and git-ime command.\n\n## What is imediff\n\nThe imediff command helps you to merge 2 slightly different files with an\noptional base file interactively or non-interactively.\n\nFor non-interactive 2-way diff operation, this can express diffs with ordinary\ndiff-format \n\n```console\n $ imediff -n older.txt newer.txt -o diff.txt\n```\n\nFor non-interactive 2-way diff operation, this can also express diffs with\nwdiff format \n\n```console\n $ imediff -n -f older.txt newer.txt -o wdiff.txt\n```\n\nFor non-interactive 3-way merge operation, this can not only express conflicts\nwith ordinary diff3-format but also 3-way wdiff format \n\n```console\n $ imediff -n yours.txt base.txt theirs.txt -o merged.txt\n $ imediff -n -f yours.txt base.txt theirs.txt -o wdiff-merged.txt\n```\nHere, this 3-way-merge logic is smarter than \"diff3 -m\".\n\nFor interactive operation, this uses the in-place alternating display of the\nchanged content on a single-pane full screen terminal user interface. The\nsource of line is clearly identified by the color of the line or the identifier\ncharacter at the first column. The advantage of this user interface is the\nminimal movement of the line of sight for the user.\n\nFor interactive 2-way pick operation, this can select sections from input\nfiles.\n\n```console\n $ imediff older.txt newer.txt -o picked.txt\n```\n\nFor interactive 3-way merge operation, this can select sections from input\nfiles.\n\n```console\n $ imediff yours.txt base.txt theirs.txt -o merged.txt\n```\n\nThe line matching logic of imediff has been improved to ignore whitespaces and\nuse partial line matches to provide the best presentation with small chunk of\nlines.\n\nThe automatic 3 way merge logic of the imediff command operates not only on the\ndifference by line but on the difference by character. This is another great\nfeature of the imediff command. So for the non-overlapping changes, it always\nyields the clean merge.\n\nYou can also use the imediff command non-interactively from CLI with --macro\noption.\n\nNOTE: There seems to be some limitation (16K?) of acceptable input lines for\nimediff program running under full screen. This causes imediff to crash. The\nroot cause seems to be the underlining ncurses binding which imediff uses.\n\n## What is git-ime\n\nThe \"git ime\" command helps you to unsquash 2 consecutive commits (`HEAD^`,\n`HEAD`) of a git repository. The \"`git rebase -i <treeish>`\" and \"`gitk`\" can\nbe used to organize unsquashed changes.\n\nIf any staged changes or local uncommitted changes are found in the git\nrepository, \"git ime\" immediately exits without changes to be on the safe side.\n\nIf the latest commit involves multiple files, \"git ime\" splits this big commit\nby the file into multiple smaller commits involving a single file for each\ncommit.\n\nIf the latest commit involves only a single file, the commit may be split into\nmultiple smaller commits involving a set of minimal partial changes. If the\ntarget file is small, splitting process may be managed interactively by\nimediff. (You can force non-interactive splitting by \"-a\" option.)\n\nThis \"git ime\" is not only useful at the checked out branch head but also at\n\"edit\" prompt during the interactive execution of \"`git rebase -i <treeish>`\".\nExecute \"git ime\" after committing the pending commit.\n\n## Quick start for Debian/Ubuntu derivative users\n\nPlease install the `imediff` package from the APT repository.\n\nAt the console command line prompt, type:\n\n* \"imediff\" to read the tutorial,\n* \"imediff -h\" to get all the command line options,\n* \"imediff -o output older newer\" to merge 2 files, and\n* \"imediff -o output yours base theirs\" to merge 3 files.\n\nFor usage instructions, type \"h\" and \"H\" in the interactive display.\n\n(The use of GNU gettext is disabled for the sake of portability.)\n\n## History and features\n\nThis was originally written by Jarno Elonen in Python2. The latest original\nupstream version was 1.1.2 released on 2007-8-18.\n\nThe original author's website was https://elonen.iki.fi/code/imediff/ . Now it\nredirects to this site https://github.com/osamuaoki/imediff .\n\nOsamu Aoki made a minor patched release for Debian buster in Oct 2018.\n\n* No more surprise hitting \"q\". You will be asked. (Fix Debian bug #799865)\n* Fix manpage generation issue (Fix Debian bug #860351)\n* New git-ime wrapper script (great for git rebase/un-squash commit)\n* You can customize key bindings.\n\nOsamu also wanted to add some features:\n\n* Use of Python3 with pyproject.toml and setuptools to organize the source\n into a module with multiple source files.\n* Use standard libraries for the flexible customization (argparse,\n configparser, logging)\n* Addition of diff3 merge capability\n* Addition of wdiff capability\n* Addition of cursor location display capability\n* Make it edit highlighted section only\n* Make its TUI more friendly under monochrome terminal\n* Use curses.wrapper()\n* CLI and logging interface for easy self-testing/debugging\n* Add decent test cases\n* Include simple tutorial within \"imediff\".\n* Add \"git-mergetool\" integration.\n* Add \"git-ime\" to help making partial patch series commits to git.\n* Good CJK wide character support with East_Asian_Width on console.\n\nThis was accomplished by practically a whole rewrite of the source code in\nNovember-December 2018. Osamu decided to release this as imediff after\nconsulting with Jarno Elonen. Now program name is without \"2\", since it\nsupports diff for not only 2 files but also 3 files. The version number is\nbumped to 2.0. In version 2.5, line matching rules are updated to produce\nbetter diff presentation.\n\n## Package installation\n\n### Deb-package\n\nYou can install `imediff` package on Debian, Ubuntu, and derivatives.\n\nThis provides `imediff` and `git-ime` commands.\n\n### Wheel-package\n\nYou can install wheel package from https://pypi.org/project/imediff/\n\nAfter installation of wheel package as a user, you need to run:\n\n```console\n $ imediff_install\n```\n\nThis installs `git-ime` shell command to the pertinent virtual environment etc.\n\n## Note to developer and translator\n\n### Building package\n\n* The building of deb-package is from \"debian\" branch.\n\n* The building of wheel-package is supported from \"main\" branch.\n\nYou must have a relatively new system with python 3.9 equivalent of Debian 12.0\n(bookworm) released on June 10th, 2023 with:\n\n* https://github.com/pypa/setuptools (>=61.0.0)\n* https://github.com/pypa/installer/\n* https://github.com/pypa/build\n* https://github.com/hukkin/tomli\n\n```console\n $ cd /path/to/source-root\n ... hack\n $ python3 -m build\n $ cd build\n $ pip install \n```\nThe building of rpm is not supported as out-of-box now (patch welcome).\n\nCode is not written for Windows compatibility in mind, yet. Gettext support was\nintentionally dropped in favor of better compatibility across various systems.\n\nThe `git-ime` command requires you to have some POSIX shell and the `git`\ncommand access.\n\n### making Debian package\n\nYou can make your own Debian package as:\n\n```console\n $ git clone https://github.com/osamuaoki/imediff.git\n $ cd imediff\n $ git checkout main\n ... hack source\n $ git commit -a\n $ rm -rf debian\n $ git add -A .\n $ git commit\n $ git tag 2.5\n $ git reset --hard HEAD^\n $ git deborig # to make ../*.orig.tar.xz\n $ sbuild\n $ cd ..\n $ sudo dpkg -i imediff_2.5-1_all.deb\n```\n\nHere, we assume the upstream version to be 2.5, and the Debian revision to be\n1.\n\nIf you have bug fixes or feature enhancement propose changes to me via \"pull\nrequest\"\n\n### updating python source\n\nPlease make sure to fit each code below 80-88 chars. (Run \"black\" on python\ncode) In case if reformat errors, check its syntax by:\n\n```console\n $ python3 -m py_compile program.py\n```\n\n### updating manpages\n\nManpages need to be updated from XML files with \"make\" first in doc/ directory\nwhen you edit it.\n\nIf you wish to update manpage from XML, `docbook-xsl` and `xsltproc` are needed\nfor building manpage from xml source then manually touch up details.\n\n### testing python source\n\nWhenever you make changes, please test them.\n\nTo test the installed module, invoke the test script as:\n\n```console\n $ cd /path/to/source-root\n $ export PYTHONPATH=$(pwd)/src/\n $ python3 test/test_unittest_all.py -v\n```\n\nTo test the installed module, invoke the test script as:\n\n```console\n $ cd /path/to/source-root\n $ python3 test/test_unittest_all.py -v\n```\n\n## Note on Debian package links\n\n* imediff2 (based on older python2 source for and before stretch)\n * https://tracker.debian.org/pkg/imediff2\n * https://packages.debian.org/source/sid/imediff2 (source package in Debian)\n * https://packages.debian.org/sid/imediff2 (binary package in Debian)\n * https://bugs.debian.org/cgi-bin/pkgreport.cgi?repeatmerged=0;src=imediff2 (BTS)\n\n* imediff: (based on newer python3 source for buster)\n * https://tracker.debian.org/pkg/imediff\n * https://packages.debian.org/source/sid/imediff (source package in Debian)\n * https://packages.debian.org/sid/imediff (binary package in Debian)\n * https://bugs.debian.org/cgi-bin/pkgreport.cgi?repeatmerged=0;src=imediff (BTS)\n\nThis is written and updated by Osamu Aoki on February 2024.\n\n",
"bugtrack_url": null,
"license": "GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The \"Program\", below, refers to any such program or work, and a \"work based on the Program\" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term \"modification\".) Each licensee is addressed as \"you\". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and \"any later version\", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the \"copyright\" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a \"copyright disclaimer\" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. ",
"summary": "2-way/3-way merge tool (CLI, Ncurses)",
"version": "2.9",
"project_urls": {
"Bug Reports": "https://github.com/osamuaoki/imediff/issues",
"Homepage": "https://github.com/osamuaoki/imediff",
"Source": "https://github.com/osamuaoki/imediff/"
},
"split_keywords": [
"imediff",
"merge",
"diff",
"cli",
"ncurses",
"git-ime",
"ime"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31290ac3729337f56274a4bdb2863034bcc16a36e24a83bff58f36ba4400410b",
"md5": "1f87832e9846a6c8b4bcfb66dbe86731",
"sha256": "dc8cd97566d36eb52ea7c7032c7f4ca9417667b2b373d73f5451bede4b529875"
},
"downloads": -1,
"filename": "imediff-2.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f87832e9846a6c8b4bcfb66dbe86731",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 62889,
"upload_time": "2024-02-17T14:26:31",
"upload_time_iso_8601": "2024-02-17T14:26:31.324996Z",
"url": "https://files.pythonhosted.org/packages/31/29/0ac3729337f56274a4bdb2863034bcc16a36e24a83bff58f36ba4400410b/imediff-2.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "05cbfc39a679fb31c98531f9e1da906e521d6f80cb5123c76cf0521f121fbe06",
"md5": "3d6ca74f6a787e59f0fcb702a9861127",
"sha256": "3d60bf8d5116e168193cb310e6d3d2bdba99abd4888c00eb6d81cf59566500e5"
},
"downloads": -1,
"filename": "imediff-2.9.tar.gz",
"has_sig": false,
"md5_digest": "3d6ca74f6a787e59f0fcb702a9861127",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 86286,
"upload_time": "2024-02-17T14:26:34",
"upload_time_iso_8601": "2024-02-17T14:26:34.292616Z",
"url": "https://files.pythonhosted.org/packages/05/cb/fc39a679fb31c98531f9e1da906e521d6f80cb5123c76cf0521f121fbe06/imediff-2.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-17 14:26:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "osamuaoki",
"github_project": "imediff",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "imediff"
}
