Commits

Markus Zapke-Gründemann committed 2dc3c48

rename files, simplify MANIFEST, improve README.rst

Comments (0)

Files changed (12)

+Frank Schneider
+Thomas Massmann

AUTHORS.txt

-Frank Schneider
-Thomas Massmann
+Changelog
+=========
+
+1.7 (2012-05-09)
+----------------
+
+* Initial release

CHANGES.txt

-Changelog
-=========
-
-1.7 (2012-05-09)
-----------------
-
-* Initial release
+Copyright (c) 2012, Inqbus GmbH & Co. KG
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Inqbus GmbH & Co. KG nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL Inqbus GmbH & Co. KG BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

LICENSES.txt

-Copyright (c) 2012, Inqbus GmbH & Co. KG
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of Inqbus GmbH & Co. KG nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL Inqbus GmbH & Co. KG BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-include *.txt *.in *.py *.cfg
-exclude requirements_tests.txt
+include AUTHORS
+include LICENSE
+include MANIFEST.in
+include *.rst
 recursive-include tests *.py
 recursive-exclude * *.pyc
+####################
+Folder Quota Checker
+####################
+
+This program returns the quota of 1st level sub directories in a directory
+using the ``du`` command (available on all \*nix platforms).
+
+
+Usage
+=====
+
+If no start directory is given all directories in the current one will be
+checked by default::
+
+   $ qcheck
+   ./directory-0   4
+   ./directory-1   920
+   ...
+   ./directory-9   8248
+   .            41264
+
+
+Choose directories
+------------------
+
+Sometimes it is required to get the quota of a defined subset of directories.
+
+It is possible to give folder names as arguments::
+
+   $ qcheck directory-1 directory-2
+   ./directory-1   920
+   ./directory-2   120
+
+
+This method only makes sense for a couple of directories. Longer folder lists
+can be passed as a text file containing one folder per line. Pass the filename
+of the text file to the program using the ``-t`` argument::
+
+   $ qcheck -t folder_set.txt
+
+
+Output
+======
+
+By default the result is written to the standard output, size is denoted in
+bits.
+
+Each directory-quota will be presented in one line::
+
+   $ qcheck
+   ./directory-0   4
+   ./directory-1   920
+   ...
+   ./directory-9   8248
+   .            41264
+
+The output can also converted to a human readable form with the ``-r``
+argument::
+
+   $ qcheck -r
+   ./directory-0 4,0K
+   ./directory-1 920K
+   ...
+   ./directory-9 8,1M
+   .           41M
+
+
+file-output
+-----------
+
+If the file output is enabled with the argument ``-f FILENAME`` the output will
+be written to a csv-file. The file will be created if it does not exist.
+
+If the *file* already exists, the new content will be added as a new column to
+the document. The name of the column contains the date like ``YY-MM``:
+
+.. csv-table:: Example CSV output
+
+   directorys;2011-12;2012-03
+   directory-1;0K;128K
+   directory-2;32M;132M
+   directory-3;980M;1.124G
+
+If the *column* already exists quotachecker will return a note that you have to
+set the ``-o`` parameter if you want to overwrite the column and exit. If the
+``-o`` argument is set quotachecker will overwrite the column if it exists.
+
+
+Requirements
+============
+
+If the installed Python version is at least 2.7 you have all what you need and
+there is nothing to install.
+
+If the installed Python version is 2.6 or less you need to install `argparse
+<http://pypi.python.org/pypi/argparse>`_ wich has already been done if you
+installed the quotachecker with pip.
+
+
+Testing
+=======
+
+If something doesn't work as described please first run the tests::
+
+  python runtests.py
+
+and send me the output if it fails.

README.txt

-####################
-Folder Quota Checker
-####################
-
-This program returns the quota of 1st level sub directories in a directory using the ``du`` command (available on all \*nix platforms).
-
-
-Usage
-=====
-
-If no start directory is given all directories in the current one will be checked by default::
-
-   $ qcheck
-   ./directory-0   4
-   ./directory-1   920
-   ...
-   ./directory-9   8248
-   .            41264
-
-
-Choose directories
-------------------
-
-Sometimes it is required to get the quota of a defined subset of directories.
-
-It is possible to give folder names as arguments::
-
-   $ qcheck directory-1 directory-2
-   ./directory-1   920
-   ./directory-2   120
-
-
-This method only make sense for a couple of directories. A greater folder list can be given by a text file.  The folder names should? be written line by line in the text file. To use it give the option ``-t`` and than the filename like this: ::
-
-   $ qcheck -t folder_set.txt
-
-If the folder doesn't exist a "DoesentExistException" will show you that for every missing Folder.
-
-
-Output
-======
-
-By default the result is written to the standard output in bit-format.
-
-Each directory-quota will be presented in one line::
-
-   $ qcheck
-   ./directory-0   4
-   ./directory-1   920
-   ...
-   ./directory-9   8248
-   .            41264
-
-
-The output can also converted to a human readable form with the ``-r`` option::
-
-   $ qcheck -r
-   ./directory-0 4,0K
-   ./directory-1 920K
-   ...
-   ./directory-9 8,1M
-   .           41M
-
-
-
-file-output
------------
-
-If the file output is enabled with the option ``-f FILENAME`` the output will be written to a csv-file. The file will be created if it does not exists.
-
-If the *file* already exists, the new content will be saved as a new column in the document. The name of the column contains the date like ``YY-MM``:
-
-.. csv-table:: Example CSV output
-
-   directorys;2011-12;2012-03
-   directory-1;0K;128K
-   directory-2;32M;132M
-   directory-3;980M;1.124G
-
-If the *column* already exists the quotachecker will return a note that you have to set the ``-o`` parameter if you want to overwrite the column and exit.
-If the ``-o`` option is set quotachecker will overwrite the column by if it exist.
-
-
-Requirements
-============
-
-If the installed python is at least 2.7 you have all what you need and there is nothing to install.
-
-If the installed python is 2.6 you need to install `argparse <http://pypi.python.org/pypi/argparse>`_ witch is already done if you installed the quotachecker with pip.
-
-
-Testing
-=======
-
-If something doesn't work as described please first run the tests::
-
-  python runtests.py
-
-ad send me me the output if it fails.
+argparse==1.2.1
+flake8==1.2
+ipdb==0.6.1
+ipython==0.12
+pytest==2.2.3
+pytest-cov==1.5

requirements_tests.txt

-argparse==1.2.1
-flake8==1.2
-ipdb==0.6.1
-ipython==0.12
-pytest==2.2.3
-pytest-cov==1.5
 
 from setuptools import Command, find_packages, setup
 
-# If you change this version, please change it allso in "CHANGES.txt"
+# If you change this version, please change it allso in "CHANGES.rst"
 version = '1.7'
 
 
 
 # package description
 desc = "Return the quota of 1st level sub folders in a directory."
-long_desc = '\n\n'.join(read(f) for f in ('README.txt', 'CHANGES.txt'))
+long_desc = '\n\n'.join(read(f) for f in ('README.rst', 'CHANGES.rst'))
 
 
 setup(name='quotachecker',