Merge pull request #89 from Pylons/standardize-repo-fix-88

Bring repo up to Pylons Projects standards

.travis.yml

@@ -3,31 +3,31 @@ language: python
 sudo: false
 
 matrix:
-    include:
-        - python: 2.7
-          env: TOXENV=py27
-        - python: 3.3
-          env: TOXENV=py34
-        - python: 3.4
-          env: TOXENV=py34
-        - python: 3.5
-          env: TOXENV=py35
-        - python: pypy
-          env: TOXENV=pypy
-        - python: 3.5
-          env: TOXENV=py2-cover,py3-cover,coverage
-        - python: 3.5
-          env: TOXENV=docs
-        - python: 2.7
-          env: TOXENV=py27-pyramid12
-        - python: 2.7
-          env: TOXENV=py27-pyramid13
-        - python: 2.7
-          env: TOXENV=py27-pyramid14
-        - python: 2.7
-          env: TOXENV=py27-pyramid15
-        - python: 2.7
-          env: TOXENV=py27-pyramid16
+  include:
+    - python: 2.7
+      env: TOXENV=py27
+    - python: 3.4
+      env: TOXENV=py34
+    - python: 3.5
+      env: TOXENV=py35
+    - python: 3.6
+      env: TOXENV=py36
+    - python: 3.7
+      env: TOXENV=py37
+      dist: xenial
+      sudo: true
+    - python: 3.8-dev
+      env: TOXENV=py38
+      dist: xenial
+      sudo: true
+    - python: pypy
+      env: TOXENV=pypy
+    - python: 3.5
+      env: TOXENV=py2-cover,py3-cover,coverage
+    - python: 3.5
+      env: TOXENV=docs
+  allow_failures:
+    - env: TOXENV=py38
 
 install:
   - travis_retry pip install tox
@@ -38,3 +38,6 @@ script:
 notifications:
   email:
     - pyramid-checkins@lists.repoze.org
+  irc:
+    channels:
+      - "chat.freenode.net#pyramid"

CHANGES.rst

@@ -1,37 +1,63 @@
-Changelog
-=========
+Change History
+==============
+
+.. _vunreleased:
+
+unreleased
+----------
+
+- Bring repo up to Pylons Project standards.
+  See https://github.com/Pylons/pyramid_mailer/pull/89
+
+- Optionally include bcc information on send.
+  See https://github.com/Pylons/pyramid_mailer/pull/87
+
+.. _v0.15.1:
 
 0.15.1 (2016-12-13)
 -------------------
 
-- Pull #83: Add the new ``.bind`` method to the ``DebugMailer`` and the
+- Add the new ``.bind`` method to the ``DebugMailer`` and the
   ``DummyMailer``. Also ``pyramid_mailer.testing`` and
   ``pyramid_mailer.debug`` now add the ``request.mailer`` request attribute.
+  https://github.com/Pylons/pyramid_mailer/pull/83
+
+
+.. _v0.15:
 
 0.15 (2016-12-06)
 -----------------
 
-- Pull #49: Support '7bit' and '8bit' transfer-encoding.
+- Support '7bit' and '8bit' transfer-encoding.
+  https://github.com/Pylons/pyramid_mailer/pull/49
 
-- Pull #70: If ``username`` and ``password`` are both set to the empty string,
+- If ``username`` and ``password`` are both set to the empty string,
   ``Mailer.from_settings``, now interprets them as being set to ``None``.
   Previously, setting them to the empty string caused SMTP authentication
   to be force with empty username and password.
+  https://github.com/Pylons/pyramid_mailer/pull/70
 
-- Pull #71: Add a ``content_id`` argument to the ``Attachment`` constructor
+- Add a ``content_id`` argument to the ``Attachment`` constructor
   which allows you to set the Content-ID header so you can reference it from
   an HTML body.
+  https://github.com/Pylons/pyramid_mailer/pull/71
 
-- Pull #72: Change file extension to ``.eml`` for mails saved from
+- Change file extension to ``.eml`` for mails saved from
   ``DebugMailer``. ``.eml`` is the standard file format for storing
   plaintext MIME (rfc822) emails.
+  https://github.com/Pylons/pyramid_mailer/pull/72
 
-- Pull #77: Drop Python 2.6 and 3.2 support.
+- Drop Python 2.6 and 3.2 support.
+  https://github.com/Pylons/pyramid_mailer/pull/77
 
 - Add Python 3.5 support.
 
-- Pull #78: Support per-request transaction managers if available via
+- Support per-request transaction managers if available via
   ``request.tm`` set by ``pyramid_tm``.
+  https://github.com/Pylons/pyramid_mailer/pull/78
+
+
+.. _v0.14.1:
 
 0.14.1 (2015-05-21)
 -------------------
@@ -44,32 +70,46 @@ Changelog
   to int comparisons are valid there but it was a latent bug.
   See https://github.com/Pylons/pyramid_mailer/pull/68
 
+
+.. _v0.14:
+
 0.14 (2014-12-10)
 -----------------
 
 - Added support for Python3.4, PyPy3.
 
-- Pull #56: Ensure that ``DebugMailer`` emulates ``Mailer`` by generating
+- Ensure that ``DebugMailer`` emulates ``Mailer`` by generating
   a sender if none is passed.
+  https://github.com/Pylons/pyramid_mailer/pull/56
 
-- Pull #52: Add configuration options for ``mail.sendmail_app`` and
+- Add configuration options for ``mail.sendmail_app`` and
   ``mail.sendmail_template`` to allow use with non-default sendmail
   configurations.
+  https://github.com/Pylons/pyramid_mailer/pull/52
 
-- Pull #50: Add ``pyramid_mailer.debug`` shorthand:  via one line in
+- Add ``pyramid_mailer.debug`` shorthand:  via one line in
   ``development.ini``, enables writing emails to a file instead of sending
   them.
+  https://github.com/Pylons/pyramid_mailer/pull/50
+
+
+.. _v0.13:
 
 0.13 (2013-07-13)
 -----------------
 
-- Pull #45:  Default transfer encoding for mail messages is now
+- Default transfer encoding for mail messages is now
   'quoted-printable'.
+  https://github.com/Pylons/pyramid_mailer/pull/45
+
+
+.. _v0.12:
 
 0.12 (2013-06-26)
 -----------------
 
-- Pull #35:  aadded support for sendmail binary via repoze.sendmail >= 4.0b2.
+- Added support for sendmail binary via repoze.sendmail >= 4.0b2.
+  https://github.com/Pylons/pyramid_mailer/pull/35
 
 - Remove "all_parts" and "attach_all_parts" from MailResponse object (unused by
   pyramid_mailer).
@@ -84,20 +124,29 @@ Changelog
 
 - Requires repoze.sendmail >= 4.1
 
+
+.. _v0.11:
+
 0.11 (2013-03-28)
 -----------------
 
-- Issue #29: Allow setting Content-Transfer-Encoding for body and html
+- Allow setting Content-Transfer-Encoding for body and html
   via Attachments.
+  https://github.com/Pylons/pyramid_mailer/issues/29
 
-- Issue #32: Fix handling of messages with both HTML and plain text
+- Fix handling of messages with both HTML and plain text
   bodies that also have attachments.
+  https://github.com/Pylons/pyramid_mailer/issues/32
 
-- Issue #24:  ensure that ``pyramid_mailer.response.to_message`` returns
+- ensure that ``pyramid_mailer.response.to_message`` returns
   text under Python 3.x.
+  https://github.com/Pylons/pyramid_mailer/issues/24
 
 - Dropped support for Python 2.5.
 
+
+.. _v0.10:
+
 0.10 (2012-11-22)
 -----------------
 
@@ -112,6 +161,9 @@ Changelog
 
 - Use ``setup.py dev`` in tox.ini.
 
+
+.. _v0.9:
+
 0.9 (2012-05-03)
 ----------------
 
@@ -120,6 +172,9 @@ Changelog
 - Depend on ``repoze.sendmail`` >= 3.2 (fixes unicode multipart message
   encoding).
 
+
+.. _v0.8:
+
 0.8 (2012-03-26)
 ----------------
 
@@ -128,13 +183,19 @@ Changelog
   (no recipient= required anymore).  See
   https://github.com/Pylons/pyramid_mailer/issues/14.
 
+
+.. _v0.7:
+
 0.7 (2012-03-26)
 ----------------
 
 - Packaging release
 
-0.6 (2012-03-20)
-----------------
+
+.. _v0.7dev:
+
+0.7dev (2012-03-20)
+-------------------
 
 - Python 2.5, 2.6, 2.7, 3.2, and pypy compatibility.
 
@@ -146,6 +207,9 @@ Changelog
 - More descriptive exception raised when attempting to send cc-only or
   bcc-only messages.  See https://github.com/Pylons/pyramid_mailer/issues/14
 
+
+.. _v0.6:
+
 0.6 (2012-01-22)
 ----------------
 
@@ -158,18 +222,27 @@ Changelog
 - Don't include ``Bcc`` header in mail messages (breaks secrecy of BCC).
   See https://github.com/Pylons/pyramid_mailer/pull/10
 
+
+.. _v0.5.1:
+
 0.5.1 (2011-11-13)
 ------------------
 
 - Fixed a bug where the mailer was only sending email to addresses in
   the "TO" field.
 
+
+.. _v0.5:
+
 0.5 (2011-10-24)
 ----------------
 
 - Drop Lamson dependency by copying Lamson's MailResponse and dependent code
   into ``pyramid_mailer.response``.
 
+
+.. _v0.4.x:
+
 0.4.X
 -----
 

README.rst

@@ -5,18 +5,18 @@
    :target: https://travis-ci.org/Pylons/pyramid_mailer
 
 .. image:: https://readthedocs.org/projects/pyramid_mailer/badge/?version=latest
-   :target: http://docs.pylonsproject.org/projects/pyramid_mailer/en/latest/
+   :target: https://docs.pylonsproject.org/projects/pyramid_mailer/en/latest/
    :alt: Documentation Status
 
 pyramid_mailer is a package for sending email from your Pyramid application.
-It is compatible with Python 2.7, 3.3, 3.4, and 3.5, as well as PyPy.
+It is compatible with Python 2.7, 3.4, 3.5, 3.6, and 3.7 as well as PyPy.
 
 This package includes:
 
 1. Wrapping the low-level Python ``email`` library with an easy-to-use
    API, which includes attachments and mulipart content.
 
-2. Send emails immediately or to add to a maildir queue.
+2. Sending emails immediately or add to a ``maildir`` queue.
 
 3. Managing email sends inside a transaction, to prevent emails being sent
    if your code raises an exception.
@@ -32,7 +32,7 @@ Links
 -----
 
 - `documentation
-  <http://docs.pylonsproject.org/projects/pyramid_mailer/en/latest/>`_
+  <https://docs.pylonsproject.org/projects/pyramid_mailer/en/latest/>`_
 
-- `development version
+- `code repository
   <https://github.com/Pylons/pyramid_mailer>`_

contributing.md

@@ -0,0 +1,37 @@
+# Contributing
+
+All projects under the Pylons Project, including this one, follow the guidelines established at [How to Contribute](https://pylonsproject.org/community-how-to-contribute.html), [Coding Style and Standards](https://pylonsproject.org/community-coding-style-standards.html), and [Pylons Project Documentation Style Guide](https://docs.pylonsproject.org/projects/pyramid_mailer/).
+
+You can contribute to this project in several ways.
+
+*   [File an Issue on GitHub](https://github.com/Pylons/pyramid_mailer/issues)
+*   Fork this project, create a new branch, commit your suggested change, and push to your fork on GitHub.
+    When ready, submit a pull request for consideration.
+    [GitHub Flow](https://guides.github.com/introduction/flow/index.html) describes the workflow process and why it's a good practice.
+    When submitting a pull request, sign [CONTRIBUTORS.txt](https://github.com/Pylons/pyramid_mailer/blob/master/CONTRIBUTORS.txt) if you have not yet done so.
+*   Join the [IRC channel #pyramid on irc.freenode.net](https://webchat.freenode.net/?channels=pyramid).
+
+## Git Branches
+
+Git branches and their purpose and status at the time of this writing are listed below.
+
+*   [master](https://github.com/Pylons/pyramid_mailer/) - The branch which should always be *deployable*. The default branch on GitHub.
+*   For development, create a new branch. If changes on your new branch are accepted, they will be merged into the master branch and deployed.
+
+## Running tests and building documentation
+
+We use [tox](https://tox.readthedocs.io/en/latest/) to automate test running, coverage, and building documentation across all supported Python versions.
+
+To run everything configured in the `tox.ini` file:
+
+    $ tox
+
+To run tests on Python 2 and 3, and ensure full coverage, but exclude building of docs:
+
+    $ tox -e py2-cover,py3-cover,coverage
+
+To build the docs only:
+
+    $ tox -e docs
+
+See the `tox.ini` file for details.

docs/changes.rst

@@ -0,0 +1 @@
+../CHANGES.rst