Mail Manager Python Interface
A set of utils for interfacing with BCC Mail Manager
The goal of this module is to provide python users with an easy way to interact with BCC Mail Manager on Windows. We hope to provide the following functionality:
- Import lists or Dicts into a new or existing mail manager job.
- Provide a simple YAML base configuration for the mail manager steps.
- Associate the sorted output from mail manager back to the user's program.
This project is still in the planning stage and as such is not currently usable.
Getting Started
Requirements
- Python 3.4+
Installation
Mail Manager Python Interface can be installed with pip:
$ pip install MailManagerPythonInterface
or directly from the source code:
$ git clone https://github.com/KyleChamberlin/mail-manager-python-interface.git
$ cd mail-manager-python-interface
$ python setup.py install
Basic Usage
After installation, the package can imported:
$ python
>>> import mailmanager
>>> mailmanager.__version__
For Contributors
Be sure to read the [[CONTRIBUTING.md]] document in this repository for further information about how to contribute to this project.
Before you contribute you will also need to sign our Contributor License Agreement which is hosted on CLAHub.
Requirements
- Make:
- Windows: http://cygwin.com/install.html
- Mac: https://developer.apple.com/xcode
- Linux: http://www.gnu.org/software/make (likely already installed)
- virtualenv: https://pypi.python.org/pypi/virtualenv#installation
- Pandoc: http://johnmacfarlane.net/pandoc/installing.html
Installation
Create a virtualenv:
$ make env
Run the tests:
$ make test
$ make tests # includes integration tests
Build the documentation:
$ make doc
Run static analysis:
$ make pep8
$ make pep257
$ make pylint
$ make check # includes all checks
Prepare a release:
$ make dist # dry run
$ make upload
Copyright
Copyright 2015 Kyle Chamberlin
License
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Apache.org - Apache License 2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
