updated setup.py and readme

Author: manfred-kaiser

MANIFEST.in

@@ -1,4 +1,3 @@
 include LICENSE.txt
 include MANIFEST.in
 include README.rst
-include requirements.txt

README.md

@@ -0,0 +1,84 @@
+# Sifter3 - Sieve email filter (RFC 5228)
+
+Sifter3 is a Python 3 implementation of the Sieve email filter language (RFC 5228) and is based on the Python 2 version from <https://github.com/garyp/sifter>
+
+![Python package](https://github.com/manfred-kaiser/sifter3/workflows/Python%20package/badge.svg)
+[![Documentation Status](https://readthedocs.org/projects/sifter3/badge/?version=master)](https://sifter3.readthedocs.io/de/master/?badge=master)
+[![CodeFactor](https://www.codefactor.io/repository/github/manfred-kaiser/sifter3/badge)](https://www.codefactor.io/repository/github/manfred-kaiser/sifter3)
+[![Github version](https://img.shields.io/github/v/release/manfred-kaiser/sifter3?label=github&logo=github)](https://github.com/manfred-kaiser/sifter3/releases)
+[![PyPI version](https://img.shields.io/pypi/v/sifter3.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/sifter3/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/sifter3.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/sifter3/)
+[![PyPI downloads](https://pepy.tech/badge/sifter3/month)](https://pepy.tech/project/sifter3/month)
+[![GitHub](https://img.shields.io/github/license/manfred-kaiser/sifter3.svg)](LICENSE)
+
+
+
+FEATURES
+========
+
+-   Supports all of the base Sieve spec from RFC 5228, except for
+    features still listed under TODO below
+-   Extensions supported:
+    -   regex (draft-ietf-sieve-regex-01)
+
+EXAMPLE
+=======
+
+    import email
+    import sifter.parser
+    rules = sifter.parser.parse_file(open('my_rules.sieve'))
+    msg = email.message_from_file(open('an_email_to_me.eml'))
+    msg_actions = rules.evaluate(msg)
+
+In the above example, `msg_actions` is a list of actions to apply to the
+email message. Each action is a tuple consisting of the action name and
+action-specific arguments. It is up to the caller to manipulate the
+message and message store based on the actions returned.
+
+WARNINGS
+========
+
+-   No thought has been given yet to hardening against malicious user
+    input. The current implementation is aimed at users that are running
+    their own sieve scripts.
+-   The current implementation is not optimized for performance, though
+    hopefully it's not too slow for normal inputs.
+
+TODO
+====
+
+In rough order of importance:
+
+-   An example adaptor that provides Unix LDA behavior using sieve for
+    filtering
+-   Base spec features not yet implemented:
+    -   encoded characters (section 2.4.2.4)
+    -   multi-line strings (section 2.4.2)
+    -   bracketed comments (section 2.3)
+    -   message uniqueness (section 2.10.3)
+    -   envelope test (section 5.4)
+    -   handle message loops (section 10)
+    -   limit abuse of redirect action (section 10)
+    -   address test should limit allowed headers to those that contain
+        addresses (section 5.1)
+-   Make sure character sets are actually handled according to the spec
+-   Make string parsing comply with the grammar in section 8.1 and the
+    features described in section 2.4.2
+-   Check that python's `email.message` implements header comparisons
+    the same way as the sieve spec
+-   Make sure regular expressions are actually handled according to the
+    extension spec
+-   Add support for various extensions:
+    -   variables (RFC 5229)
+    -   externally stored lists (draft-melnikov-sieve-external-lists)
+    -   body (RFC 5173)
+    -   relational (RFC 5231)
+    -   subaddress (RFC 5233)
+    -   copy (RFC 3894)
+    -   environment (RFC 5183)
+    -   date and index (RFC 5260)
+    -   editheader (RFC 5293)
+    -   ihave (RFC 5463)
+    -   mailbox metadata (RFC 5490)
+    -   notifications (RFC 5435), mailto notifications (RFC 5436), xmpp
+        notifications (RFC 5437)

README.rst

@@ -5,27 +5,28 @@
 # read the contents of your README file
 from os import path
 this_directory = path.abspath(path.dirname(__file__))
-with open(path.join(this_directory, 'README.rst'), encoding='utf-8') as f:
+with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
     long_description = f.read()
 
-with open('requirements.txt') as f:
-    requirements = f.read().splitlines()
-
 setup(
-    name="sifter",
+    name="sifter3",
     version="0.2.0",
-    author="Gary Peck, Manfred Kaiser",
-    author_email="gary@realify.com, manfred.kaiser@logfile.at",
+    author="Manfred Kaiser, Gary Peck",
+    author_email="manfred.kaiser@logfile.at, gary@realify.com",
     url="https://github.com/garyp/sifter",
     license="BSD",
+    description='Parser/evaluator for the Sieve filtering language (RFC 5228) - Python3 version',
     long_description=long_description,
-    long_description_content_type='text/x-rst',
+    long_description_content_type='text/markdown',
+    keywords="sieve email filter parser",
     project_urls={
-        'Source': 'https://github.com/garyp/sifter',
-        'Tracker': 'https://github.com/garyp/sifter/issues',
+        'Source': 'https://github.com/manfred-kaiser/sifter3',
+        'Tracker': 'https://github.com/manfred-kaiser/sifter3/issues',
     },
     python_requires='>= 3.6',
-    install_requires=requirements,
+    install_requires=[
+        'ply'
+    ],
     classifiers=[
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",