From d015e0af61dd56fb9ca302d9e43987662c8da090 Mon Sep 17 00:00:00 2001 From: radzhome Date: Fri, 29 Jan 2016 14:46:10 -0500 Subject: [PATCH] update release changes, doc readme --- CHANGES.rst | 12 ++++++++---- README.rst | 25 ++++++++++++++++--------- doc_source/README.rst | 19 ++++++++++--------- fedex/__init__.py | 2 +- 4 files changed, 35 insertions(+), 23 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 876cda9..12a005c 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,14 +1,18 @@ Change Log ========== -Next release ------------- +2.3.0 +----- * Added Location Service using v3 WSDL. (radzhome) * Added examples and unit tests for Location Service. (radzhome) -* Updated certification process. (radzhome) +* Updated certification process scripts to work with latest WSDLs. (radzhome) * Added warning logging for requests that come back with warning notes. (radzhome) - +* Added PyPI, Travis, requires.io integration/badges. (radzhome) +* Organization change from gtaylor to python-fedex-devs. (gtaylor) +* Added deprecation message for movement service. (radzhome) +* Added conversion tools to convert suds xml object into python dict. (radzhome) +* Redirect logging to stdout for examples and tests when not ran via nose. (radzhome) 2.2.0 ----- diff --git a/README.rst b/README.rst index 56fa101..f7679be 100644 --- a/README.rst +++ b/README.rst @@ -33,13 +33,16 @@ The easiest way is via pip or easy_install:: Quick Start ----------- -Edit the `example_config.py` file in `examples/` with your fedex credentials +- Clone this repository. + +- Edit the `example_config.py` file in See `examples/ `_ with your fedex credentials and run any of the provided examples. Documentation ------------- -Refer to the documentation_ for more details on the project. +Refer to the documentation_ for more details on the project. Latest doc builds +are found in docs_ and doc build scripts in doc_source_. There are also a lot of useful examples under the examples directory within this directory. @@ -47,30 +50,32 @@ this directory. Support ------- -Head over to https://github.com/gtaylor/python-fedex/issues -and submit an issue if you have any problems or questions. +Issues & Questions: https://github.com/gtaylor/python-fedex/issues + Most problems are going to require investigation or a submitted pull request by someone from the Python FedEx Developers organization. To contribute a new feature or service, feel free to create a pull request. +We are always looking for new contributors to help maintain the project. Fedex Support and Documentation ------------------------------- Fedex Support Email: websupport@fedex.com Developer Portal: http://www.fedex.com/us/developer/ +Updates To Services: https://www.fedex.com/us/developer/web-services/process.html (FedEx Web Services Announcements) Todos ----- - * Read the docs documentation - * Travis test integration - * Increase validation - * Remove deprecated services + +- Read the docs documentation +- Increase service specific request validation +- Remove deprecated services (package movement service) Legal ----- Copyright (C) 2008-2015 Greg Taylor -Copyright (C) 2016 Python FedEx Developers +Copyright (C) 2015-2016 Python FedEx Developers This software is licensed under the BSD License. @@ -78,3 +83,5 @@ python-fedex is not authored by, endorsed by, or in any way affiliated with FedEx. .. _documentation: https://pythonhosted.org/fedex/ +.. _docs: docs/ +.. _doc_source: doc_source/ diff --git a/doc_source/README.rst b/doc_source/README.rst index 29a7be7..84fdb7f 100644 --- a/doc_source/README.rst +++ b/doc_source/README.rst @@ -1,12 +1,13 @@ -python-fedex Examples -===================== +python-fedex documentation +========================== -This directory contains a number of examples of how to use python-fedex. For -these examples to work, you must open example_config.py and enter your -testing account credentials there. +This directory contains build scripts for python-fedex documentation +using epydoc 3.0.1. The following was used to generate doc: -To run all tests from bash, type: + cd python-fedex/docs + epydoc -v -o 2.X.X ../fedex/ - for f in *.py; do python "$f"; done - # Or use the below to only see response errors: - for f in *.py; do python "$f"; done | grep -i error \ No newline at end of file +The current documentation is hosted at https://pythonhosted.org/fedex/. +Sometime inn the near future, the plan is to move documentation over from +epydoc to sphinx, and host it on documentation at +http://python-fedex.readthedocs.org/. diff --git a/fedex/__init__.py b/fedex/__init__.py index 797af11..a783ffd 100644 --- a/fedex/__init__.py +++ b/fedex/__init__.py @@ -52,4 +52,4 @@ our U{Github project} and enter an issue in the U{Issue Tracker}. """ -VERSION = __version__ = '2.2.0' +VERSION = __version__ = '2.3.0'