From 97c3ab9bf9955d60dd9361246034996126fb4cf3 Mon Sep 17 00:00:00 2001 From: Gertjan van Zwieten Date: Mon, 26 Jun 2017 11:49:37 +0200 Subject: [PATCH] add setup fields and installation info --- README.md | 17 +++++++++++------ setup.py | 31 +++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fa271fb..2ea8a40 100644 --- a/README.md +++ b/README.md @@ -15,12 +15,12 @@ a common naming structure. It also requires fluidity in Perl's regular expression syntax to be useful, which sets a very high bar for entry. Mvi (which can be seen to be either a contraction of "mv vi" or a more general -abbreviation of "move interactively", per preference) aims to simplify bulk -renames of files and directories by opening the current directory listing in a -text editor, thus providing a powerful interface for editing destination paths. -Names can be changed by editing the lines in place while preserving order. Upon -save and exit mvi will show a list of scheduled rename operations and ask for -confirmation. +abbreviation of "move interactively") aims to simplify bulk renames of files +and directories by opening the directory listing in a text editor, thus +providing a powerful interface for editing destination paths. Names can be +changed by editing the lines in place while preserving order. Upon save and +exit mvi will show a list of scheduled rename operations and ask for +confirmation before performing the changes on disk. ## examples @@ -85,3 +85,8 @@ Python's setuptools: Or in ~/.local/bin: python3 setup.py install --user + +Mvi is also available on [pypi](https://pypi.org/project/mvi/) for installation +via pip: + + pip3 install mvi diff --git a/setup.py b/setup.py index 5683318..3597826 100644 --- a/setup.py +++ b/setup.py @@ -2,10 +2,41 @@ import mvi, setuptools +description = 'Move files by text edit' + +long_description = '''\ +Organising large amounts of files via the command line is cumbersome. The +standard UNIX `mv` command can rename a file or directory, or move items in +bulk, but the two operations cannot be combined. Furthermore, editing +capabilities on the command line offered by most shells are too limited to +comfortably alter long file or directory names, or add characters from foreign +character sets. Names containing spaces or other special characters should be +quoted or escaped, adding yet another layer of annoyance. + +Larry Wall's `rename` complements `mv` with the ability to rename in bulk, but +being based on regular expressions it is suited mostly for file sets that share +a common naming structure. It also requires fluidity in Perl's regular +expression syntax to be useful, which sets a very high bar for entry. + +Mvi (which can be seen to be either a contraction of "mv vi" or a more general +abbreviation of "move interactively") aims to simplify bulk renames of files +and directories by opening the directory listing in a text editor, thus +providing a powerful interface for editing destination paths. Names can be +changed by editing the lines in place while preserving order. Upon save and +exit mvi will show a list of scheduled rename operations and ask for +confirmation before performing the changes on disk.''' + setuptools.setup( name='mvi', version=mvi.__version__, + description=description, + long_description=long_description, + url='https://github.com/gertjanvanzwieten/mvi', author='Gertjan van Zwieten', + author_email = 'git@gjvz.nl', + license='MIT', + install_requires=[], + python_requires='>=3', py_modules=['mvi'], scripts=['mvi'], )