setuptools likes README.rst not readme.rst

This commit is contained in:
Noah Levitt 2018-07-17 16:35:05 +00:00
parent ec7a0bf569
commit 8022257a57
4 changed files with 7 additions and 7 deletions

View File

@ -125,7 +125,7 @@ configuration information and metadata with each proxy request to warcprox. The
value is a json blob. There are several fields understood by warcprox, and
arbitrary additional fields can be included. If warcprox doesn't recognize a
field it simply ignores it. Custom fields may be useful for custom warcprox
plugins (see `<readme.rst#plugins>`_).
plugins (see `<README.rst#plugins>`_).
Warcprox strips the ``warcprox-meta`` header out before sending the request to
remote server, and does not write it in the warc request record.
@ -152,7 +152,7 @@ Example::
``dedup-bucket`` (string)
~~~~~~~~~~~~~~~~~~~~~~~~~
Specifies the deduplication bucket. For more information about deduplication
see `<readme.rst#deduplication>`_.
see `<README.rst#deduplication>`_.
Example::
@ -206,7 +206,7 @@ of the bucket. The other currently recognized key is ``tally-domains``, which
if supplied should be a list of domains. This instructs warcprox to
additionally tally substats of the given bucket by domain.
See `<readme.rst#statistics>`_ for more information on statistics kept by
See `<README.rst#statistics>`_ for more information on statistics kept by
warcprox.
Examples::
@ -223,7 +223,7 @@ limit on a domain specified in ``tally-domains``.
~~~~~~~~~~~~~~~~~~~~~~~
Specifies quantitative limits for warcprox to enforce. The structure of the
dictionary is ``{stats_key: numerical_limit, ...}`` where stats key has the
format ``"bucket/sub-bucket/statistic"``. See `readme.rst#statistics`_ for
format ``"bucket/sub-bucket/statistic"``. See `README.rst#statistics`_ for
further explanation of what "bucket", "sub-bucket", and "statistic" mean here.
If processing a request would result in exceeding a limit, warcprox aborts

View File

@ -40,12 +40,12 @@ except:
setuptools.setup(
name='warcprox',
version='2.4b2.dev176',
version='2.4b2.dev177',
description='WARC writing MITM HTTP/S proxy',
url='https://github.com/internetarchive/warcprox',
author='Noah Levitt',
author_email='nlevitt@archive.org',
long_description=open('readme.rst').read(),
long_description=open('README.rst').read(),
license='GPL',
packages=['warcprox'],
install_requires=deps,

View File

@ -193,7 +193,7 @@ def _build_arg_parser(prog='warcprox'):
action='append', help=(
'Qualified name of plugin class, e.g. "mypkg.mymod.MyClass". '
'May be used multiple times to register multiple plugins. '
'See readme.rst for more information.'))
'See README.rst for more information.'))
arg_parser.add_argument('--version', action='version',
version="warcprox {}".format(warcprox.__version__))
arg_parser.add_argument('-v', '--verbose', dest='verbose', action='store_true')