diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..c6ee11c --- /dev/null +++ b/.editorconfig @@ -0,0 +1,17 @@ + +root = true + +[*] +insert_final_newline = true + +[*.{js,py}] +charset = utf-8 + +[*.py] +indent_style = space +indent_size = 4 + +# Matches the exact files either package.json or .travis.yml +[*.{json,yml}] +indent_style = space +indent_size = 2 diff --git a/.gitignore b/.gitignore index 8f29d62..87b7528 100644 Binary files a/.gitignore and b/.gitignore differ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e8fa8f6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,24 @@ +Change Log +========== + +Unreleased Changes +------------------ + + +0.1.0 (2015-02-21) +------------------ + + ### CHANGED + + - **[license](LICENSE)** from **MIT** to **Apache 2.0** + - default virtualenv from `env` to `.env` + - `.gitignore` to cover more of the possible files encountered during development. + + +0.0.0 (2015-02-17) +------------------ + + ### ADDED + + - cookiecutter template from jacebrowning/template-python + - **MIT** [license](LICENSE.txt) \ No newline at end of file diff --git a/CHANGES.md b/CHANGES.md deleted file mode 100644 index 0b5770b..0000000 --- a/CHANGES.md +++ /dev/null @@ -1,7 +0,0 @@ -Changelog -========= - -0.0.0 (2013/10/09) ------------------- - - - diff --git a/CLA.md b/CLA.md new file mode 100644 index 0000000..d5000fc --- /dev/null +++ b/CLA.md @@ -0,0 +1,66 @@ +Mail Manager Python Interface +============================= + +Contributor License Agreement: +------------------------------ + +Thank you for your interest in the Mail Manager Python Interface open source project being +administered by Kyle Chamberlin, Inc. The form of license below is a document that +clarifies the terms under which You, the person listed below, may contribute +software, bug fixes, configuration changes, documentation, or any other +materials that you send to us related to the Project (each a “Contribution”) to +the project. We appreciate your participation in our project, and your help in +improving the project, so we want you to understand what will be done with the +Contributions. This license is for your protection as well as the protection of +Kyle Chamberlin and its licensees; it does not change your rights to use your own +Contributions for any other purpose. Please complete the following information +about you and the Contributions and sign electronically by filling out the form +below. + +If you have questions about these terms, please contact me at +kylechamberlin@project20million.org. + +### Corporate Contributions: + +If you are employed as a software engineer, or if your +employer is in the business of developing software, or otherwise may claim +rights in the Contributions, please provide information about your employer’s +policy on contributing to open source projects, including the name of the +supervisor to contact in connection with such contributions. + +### You and Kyle Chamberlin agree: +- You grant us the ability to use the Contributions in any +way. You hereby grant to Kyle Chamberlin, a non-exclusive, irrevocable, worldwide, +royalty-free, sublicenseable, transferable license under all of Your relevant +intellectual property rights (including copyright, patent, and any other +rights), to use, copy, prepare derivative works of, distribute and publicly +perform and display the Contributions on any licensing terms, including without +limitation: (a) open source licenses like the MIT License, GNU General Public +License (GPL), the GNU Lesser General Public License (LGPL), the Common Public +License, or the Berkeley Software Distribution license (BSD); and (b) binary, +proprietary, or commercial licenses. Except for the licenses granted herein, +You reserve all right, title, and interest in and to the Contribution. +- You are able to grant us these rights. You represent that You are legally entitled to +grant the above license. If Your employer has rights to intellectual property +that You create, You represent that You have received permission to make the +Contributions on behalf of that employer, or that Your employer has waived such +rights for the Contributions. +- The Contributions are your original work. You +represent that the Contributions are Your original works of authorship, and to +Your knowledge, no other person claims, or has the right to claim, any right in +any invention or patent related to the Contributions. You also represent that +You are not legally obligated, whether by entering into an agreement or +otherwise, in any way that conflicts with the terms of this license. For +example, if you have signed an agreement requiring you to assign the +intellectual property rights in the Contributions to an employer or customer, +that would conflict with the terms of this license. +- We determine the code that +is in our project. You understand that the decision to include the Contribution +in any project or source repository is entirely that of Kyle Chamberlin, and this +agreement does not guarantee that the Contributions will be included in any +product. +- No Implied Warranties. Kyle Chamberlin acknowledges that, except as explicitly +described in this Agreement, the Contribution is provided on an “AS IS” BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, +INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, +NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7379996 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,80 @@ +# How to contribute + +Third-party patches are an essential part of open source software. We want +to keep it as easy as possible to contribute changes that get things working. +There are a few guidelines that we need contributors to follow so that we can +have a chance of keeping on top of things. + +## Getting Started + +* Make sure you have a [GitHub account](https://github.com/signup/free) +* Submit an issue on GitHub, assuming one does not already exist. + * Clearly describe the issue including steps to reproduce when it is a bug. + * Make sure you fill in the earliest version that you know has the issue. +* Fork the repository on GitHub + +## Making Changes + +* Create a topic branch from where you want to base your work. + * This is usually the master branch. + * Only target release branches if you are certain your fix must be on that + branch. + * To quickly create a topic branch based on master; `git checkout -b + fix/master/my_contribution master`. Please avoid working directly on the + `master` branch. +* Make commits of logical units. +* Check for unnecessary whitespace with `git diff --check` before committing. +* Make sure your commit messages are in the proper format. + +```` + (ISSUE NUMBER) Title of the bug being fixed. + + Without this patch applied the bug persists. This is a problem because the + contributor is left to imagine what the commit message should look like + based on a description rather than an example. This patch fixes the + problem by making the example concrete and imperative. + + The first line should be a real life issue number from the GitHub issue tracker. + The body describes the behaviour without the patch, why this is a problem, and + how the patch fixes the problem when applied. +```` + +* Make sure you have added the necessary tests for your changes. +* Run _all_ the tests to assure nothing else was accidentally broken. + +## Making Trivial Changes + +### Documentation + +For changes of a trivial nature to comments and documentation, it is not +always necessary to create a new issue on GitHub. In this case, it is +appropriate to start the first line of a commit with '(doc)' instead of +an issue number. + +```` + (doc) Add typo/documentation commit example to CONTRIBUTING + + There is no example for contributing a documentation commit + to the Puppet repository. This is a problem because the contributor + is left to assume how a commit of this nature may appear. + + The first line is a real life imperative statement with '(doc)' in + place of what would have been the ticket number in a + non-documentation related commit. The body describes the nature of + the new documentation or comments added. +```` + +## Submitting Changes + +* Sign the [Contributor License Agreement](https://www.clahub.com/agreements/KyleChamberlin/mail-manager-python-interface). +* Push your changes to a topic branch in your fork of the repository. +* Submit a pull request to the repository in the organization. +* The core team looks at Pull Requests on a regular basis. +* After feedback has been given we expect responses within two weeks. After two + weeks will may close the pull request if it isn't showing any activity. + +# Additional Resources + +* [Contributor License Agreement](https://www.clahub.com/agreements/KyleChamberlin/mail-manager-python-interface) +* [General GitHub documentation](http://help.github.com/) +* [GitHub pull request documentation](http://help.github.com/send-pull-requests/) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3817ce0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2015 Kyle Chamberlin + + 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 + + http://www.apache.org/licenses/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. diff --git a/LICENSE.txt b/LICENSE.txt deleted file mode 100644 index 715fc92..0000000 --- a/LICENSE.txt +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2015 Kyle Chamberlin - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/MailManagerPythonInterface.sublime-project b/MailManagerPythonInterface.sublime-project deleted file mode 100644 index 8f0b041..0000000 --- a/MailManagerPythonInterface.sublime-project +++ /dev/null @@ -1,42 +0,0 @@ -{ - "folders": - [ - { - "path": ".", - "file_exclude_patterns": [".coverage", "*.sublime-workspace"], - "folder_exclude_patterns": [".*", "__pycache__", "build", "dist", "env", "*.egg-info"] - } - ], - "settings": - { - "tab_size": 4, - "translate_tabs_to_spaces": true - }, - "SublimeLinter": - { - "linters": - { - "pep257": { - "@disable": false, - "args": [], - "excludes": [] - }, - "pep8": { - "@disable": false, - "args": [], - "excludes": [], - "ignore": "E501", - "max-line-length": 79, - "select": "" - }, - "pylint": { - "@disable": false, - "args": ["--max-line-length=79"], - "disable": "I0011,W0142,W0511,R0801", - "enable": "", - "excludes": [], - "rcfile": "" - } - } - }, -} diff --git a/Makefile b/Makefile index 5456dbc..be61e74 100644 --- a/Makefile +++ b/Makefile @@ -35,7 +35,7 @@ else endif # virtualenv paths -ENV := env +ENV := .env ifneq ($(findstring win32, $(PLATFORM)), ) BIN := $(ENV)/Scripts OPEN := cmd /c start @@ -96,13 +96,13 @@ $(PIP): depends: depends-ci depends-dev .PHONY: depends-ci -depends-ci: env Makefile $(DEPENDS_CI) +depends-ci: .env Makefile $(DEPENDS_CI) $(DEPENDS_CI): Makefile $(PIP) install --upgrade pep8 pep257 pylint $(TEST_RUNNER) coverage touch $(DEPENDS_CI) # flag to indicate dependencies are installed .PHONY: depends-dev -depends-dev: env Makefile $(DEPENDS_DEV) +depends-dev: .env Makefile $(DEPENDS_DEV) $(DEPENDS_DEV): Makefile $(PIP) install --upgrade pep8radius pygments docutils pdoc wheel touch $(DEPENDS_DEV) # flag to indicate dependencies are installed diff --git a/README.md b/README.md index 0cd60ef..edee5c9 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,37 @@ -MailManagerPythonInterface -====== -A set of utils for interfacing with mail manager +Mail Manager Python Interface +============================= +A set of utils for interfacing with [BCC Mail Manager](http://www.bccsoftware.com/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](https://microsoft.com/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. [![Build Status](http://img.shields.io/travis/KyleChamberlin/mail-manager-python-interface/master.svg)](https://travis-ci.org/KyleChamberlin/mail-manager-python-interface) [![Coverage Status](http://img.shields.io/coveralls/KyleChamberlin/mail-manager-python-interface/master.svg)](https://coveralls.io/r/KyleChamberlin/mail-manager-python-interface) [![Scrutinizer Code Quality](http://img.shields.io/scrutinizer/g/KyleChamberlin/mail-manager-python-interface.svg)](https://scrutinizer-ci.com/g/KyleChamberlin/mail-manager-python-interface/?branch=master) [![PyPI Version](http://img.shields.io/pypi/v/MailManagerPythonInterface.svg)](https://pypi.python.org/pypi/MailManagerPythonInterface) [![PyPI Downloads](http://img.shields.io/pypi/dm/MailManagerPythonInterface.svg)](https://pypi.python.org/pypi/MailManagerPythonInterface) - +[![Documentation Status](https://readthedocs.org/projects/mail-manager-python-interface/badge/?version=latest)](https://readthedocs.org/projects/mail-manager-python-interface/?badge=latest) Getting Started =============== + Requirements ------------ -* Python 3.3+ +* Python 3.4+ Installation ------------ -MailManagerPythonInterface can be installed with pip: +Mail Manager Python Interface can be installed with pip: + ``` $ pip install MailManagerPythonInterface @@ -45,11 +56,13 @@ $ python >>> mailmanager.__version__ ``` -MailManagerPythonInterface doesn't do anything, it's a template. - 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](CLA.md) which is [hosted on CLAHub](https://www.clahub.com/agreements/KyleChamberlin/mail-manager-python-interface). + Requirements ------------ @@ -59,31 +72,30 @@ Requirements * 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 -* Graphviz: http://www.graphviz.org/Download.php Installation ------------ -Create a virtualenv: +#### Create a virtualenv: ``` $ make env ``` -Run the tests: +#### Run the tests: ``` $ make test $ make tests # includes integration tests ``` -Build the documentation: +#### Build the documentation: ``` $ make doc ``` -Run static analysis: +#### Run static analysis: ``` $ make pep8 @@ -92,9 +104,29 @@ $ make pylint $ make check # includes all checks ``` -Prepare a release: +#### 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](https://www.apache.org/licenses/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.* diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 65bb7cb..0000000 --- a/docs/.gitignore +++ /dev/null @@ -1 +0,0 @@ -# remove this placeholder after adding files diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..2030d2c --- /dev/null +++ b/docs/README.md @@ -0,0 +1,49 @@ +Mail Manager Python Interface +============================= + +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__ +``` diff --git a/mailmanager/__init__.py b/mailmanager/__init__.py index 9b8d990..1537eb2 100644 --- a/mailmanager/__init__.py +++ b/mailmanager/__init__.py @@ -3,7 +3,7 @@ import sys __project__ = 'MailManagerPythonInterface' -__version__ = '0.0.0' +__version__ = '0.1.0' VERSION = __project__ + '-' + __version__ diff --git a/setup.py b/setup.py index 866c0fa..7b75756 100644 --- a/setup.py +++ b/setup.py @@ -7,18 +7,18 @@ from mailmanager import __project__, __version__ import os -if os.path.exists('README.rst'): - README = open('README.rst').read() +if os.path.exists('README.md'): + README = open('README.md').read() else: README = "" # a placeholder, readme is generated on release -CHANGES = open('CHANGES.md').read() +CHANGES = open('CHANGELOG.md').read() setuptools.setup( name=__project__, version=__version__, - description="MailManagerPythonInterface is a Python 3 package template.", + description="Mail Manager Python Interface is a Python 3 package template.", url='https://github.com/KyleChamberlin/mail-manager-python-interface', author='Kyle Chamberlin', author_email='KyleChamberlin@project20million.org', @@ -33,7 +33,7 @@ 'Development Status :: 1 - Planning', 'Natural Language :: English', 'Operating System :: OS Independent', - 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4', ], install_requires=open('requirements.txt').readlines(),