Merge pull request #134 from purplship/purplship-sdk-2021.6

[release] purplship SDK 2021.6

Author: danh91

.coveragerc

@@ -4,7 +4,6 @@ branch = True
 omit =
     */purplship/extensions/boxknight/*
     */purplship/extensions/dicom/*
-    */purplship/extensions/usps/*
 
 [report]
 include =

.github/workflows/pythonpackage.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: puprlship-sdk
+name: purplship-sdk
 
 on: [push]
 

README.md

@@ -1,32 +1,32 @@
 <p align="center">
   <p align="center">
     <a href="https://purplship.com" target="_blank">
-      <img src="https://github.com/PurplShip/purplship/raw/main/docs/images/icon.png" alt="Purplship" height="100">
+      <img src="https://github.com/purplship/purplship/raw/main/docs/images/icon.png" alt="purplship" height="100">
     </a>
   </p>
   <h2 align="center">
-    Purplship - The Open Source multi-carrier shipping SDK
+    purplship - The Open Source multi-carrier shipping SDK
   </h2>
   <p align="center">
-    <a href="https://github.com/Purplship/Purplship/actions"><img src="https://github.com/Purplship/Purplship/workflows/puprlship-sdk/badge.svg" alt="CI" style="max-width:100%;"></a>
-    <a href="https://www.gnu.org/licenses/lgpl-3.0" rel="nofollow"><img src="https://img.shields.io/badge/License-LGPL%20v3-blue.svg" alt="License: LGPL v3" data-canonical-src="https://img.shields.io/badge/License-AGPL%20v3-blue.svg" style="max-width:100%;"></a>
+    <a href="https://github.com/purplship/purplship/actions"><img src="https://github.com/purplship/purplship/workflows/purplship-sdk/badge.svg" alt="CI" style="max-width:100%;"></a>
+    <a href="https://www.gnu.org/licenses/lgpl-3.0" rel="nofollow"><img src="https://img.shields.io/badge/License-LGPL%20v3-blue.svg" alt="License: LGPL v3" data-canonical-src="https://img.shields.io/badge/License-LGPL%20v3-blue.svg" style="max-width:100%;"></a>
     <a href="https://github.com/python/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black" style="max-width:100%;"></a>
-    <a href="https://codecov.io/gh/PurplShip/purplship"><img src="https://codecov.io/gh/PurplShip/purplship/branch/main/graph/badge.svg?token=D07fio4Dn6"/></a>
-    <a href="https://app.codacy.com/manual/DanH91/Purplship?utm_source=github.com&utm_medium=referral&utm_content=Purplship/Purplship&utm_campaign=Badge_Grade_Dashboard"><img src="https://api.codacy.com/project/badge/Grade/a57baa23a1ca4403a37a8b7134609709" alt="Codacy Badge" style="max-width:100%;"></a>
+    <a href="https://codecov.io/gh/purplship/purplship"><img src="https://codecov.io/gh/purplship/purplship/branch/main/graph/badge.svg?token=D07fio4Dn6"/></a>
+    <a href="https://www.codacy.com/gh/purplship/purplship/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=purplship/purplship&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/cc2ac4fcb6004bca84e42a90d8acfe41"></a>
   </p>
 </p>
 
-Puprlship is a modern development kit that simplifies the integration of shipping carriers services into an app.
+puprlship is a modern development kit that simplifies the integration of shipping carriers services into an app.
 
 The key features are:
 
 - **Unified API**: A standardized set of models representing the common shipping data (`Address`, `Parcel`, `Shipment`...)
-- **Intuitive API**: A library that abstracts and unifies the typical shipping API services (`Rating`, `Pickup`, `Tracking`...) 
-- **Multi-carrier**: Integrate Purplship once and connect to multiple shipping carrier APIs
+- **Intuitive API**: A library that abstracts and unifies the typical shipping API services (`Rating`, `Shipping`, `Tracking`...) 
+- **Multi-carrier**: Integrate purplship once and connect to multiple shipping carrier APIs
 - **Custom carrier**: A framework to integrate a shipping carrier services within hours instead of months
 
 
-*For a complete shipping management REST API with a dashboard checkout [purplship-server](https://github.com/PurplShip/purplship-server).*
+*For a complete shipping management REST API with a dashboard checkout [purplship-server](https://github.com/puprlship/purplship-server).*
 
 
 ## Requirements
@@ -56,12 +56,14 @@ Additional extensions:
 - `purplship.dhl-universal`
 - `purplship.dicom`
 - `purplship.fedex`
-- `purplship.purolator-courier`
+- `purplship.purolator`
 - `purplship.royalmail`
 - `purplship.sendle`
 - `purplship.sf-express`
+- `purplship.tnt`
 - `purplship.ups`
 - `purplship.usps`
+- `purplship.usps-international`
 - `purplship.yanwen`
 - `purplship.yunexpress`
 
@@ -156,16 +158,16 @@ print(rates)
 ## Resources
 
 - [**Documentation**](https://sdk.purplship.com)
-- [**Bug Tracker**](https://github.com/PurplShip/purplship/issues)
+- [**Bug Tracker**](https://github.com/puprlship/purplship/issues)
 - [**Community on Discord**](https://discord.gg/kXEa3UMRHd)
 
 ## Contributing
 
-We encourage you to contribute to Purplship! Please check out the
-[Contributing to Purplship guide](/docs/development/contributing.md) for guidelines about how to proceed.
-[Join us!](https://gitter.im/Purplship/Purplship?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+We encourage you to contribute to puprlship! Please check out the
+[Contributing to purplship guide](/docs/development/contributing.md) for guidelines about how to proceed.
+[Join the purplship Community!](https://github.com/purplship/purplship/discussions)
 
-Do you want to extend Purplship and integrate a custom carrier, check out [Extending Purplship](https://sdk.purplship.com/development/extending/)
+Do you want to extend purplship and integrate a custom carrier, check out [Extending purplship](https://sdk.purplship.com/development/extending/)
 
 ## License
 
@@ -176,4 +178,4 @@ Please see [LICENSE.md](/LICENSE) for licensing details.
 ## Authors
 
 - **Daniel K.** | [@DanHK91](https://twitter.com/DanHK91) | [danielk.xyz](https://danielk.xyz/)
-- **Purplship Team** | hello@purplship.com | [purplship.com](https://purplship.com)
+- **purplship** | hello@purplship.com | [purplship.com](https://purplship.com)

docs/contributing.md

@@ -1,9 +1,9 @@
-## Contribute to Purplship
+## Contribute to purplship
 
 ### **Did you find a bug?**
 
 * **Do not open up a GitHub issue if the bug is a security vulnerability
-  in Purplship**, and instead send us an email at hello@purplship.com.
+  in purplship**, and instead send us an email at hello@purplship.com.
 
 * **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/PurplShip/purplship/issues).
 
@@ -23,11 +23,11 @@
 
 ### **Do you have questions about the source code?**
 
-* Ask any question about how to use Purplship in the [purplship room](https://gitter.im/Purplship/Purplship).
+* Ask any question about how to use purplship in the [purplship room](https://gitter.im/purplship/purplship).
 
 * Check out the [architecture overview](/architecture)
 
 
 Thanks!
 
-Daniel K, Purplship
+Daniel K, purplship

docs/development/architecture.md

@@ -1,19 +1,19 @@
 ## Overview
 
-Purplship proposes a set of unified APIs accepting all required data to send requests to the supported carrier services.
+purplship proposes a set of unified APIs accepting all required data to send requests to the supported carrier services.
 
-The typical data flows for all requests processed by Purplship is illustrated bellow.
+The typical data flows for all requests processed by purplship is illustrated bellow.
 
 <figure>
   <img src="/images/purplship-sequence-diagram.svg" height="300" />
-  <figcaption>Purplship - Sequence</figcaption>
+  <figcaption>purplship - Sequence</figcaption>
 </figure>
 
-To accomplish this, the overall abstraction proposed by Purplship come down to the implementation these abstract classes.
+To accomplish this, the overall abstraction proposed by purplship come down to the implementation these abstract classes.
 
 <figure>
   <img src="/images/purplship-class-diagram.svg" height="300" />
-  <figcaption>Purplship - Class Diagram</figcaption>
+  <figcaption>purplship - Class Diagram</figcaption>
 </figure>
 
 ### The `Settings`
@@ -30,7 +30,7 @@ To accomplish this, the overall abstraction proposed by Purplship come down to t
 ### The `Mapper`
 
 !!! abstract ""
-    The `Mapper` class translates the unified Purplship API data into carrier specific data to send requests
+    The `Mapper` class translates the unified purplship API data into carrier specific data to send requests
     and also takes care or parsing the response returned back into a unified data model 
 
     Learn more about the Mapper pattern from [Martin Fowler Enterprise Pattern](https://martinfowler.com/eaaCatalog/dataMapper.html)
@@ -70,7 +70,7 @@ canadapost_proxy = Proxy(canadapost_settings)
 from purplship.core.models import PickupRequest, Address
 
 
-# A Purplship unified Pickup request type
+# A purplship unified Pickup request type
 pickup_request: PickupRequest = PickupRequest(
     pickup_date="2021-12-15",
     ready_time="10:00",
@@ -90,7 +90,7 @@ canadapost_pickup_request = canadapost_mapper.create_pickup_request(pickup_reque
 # Send the request the carrier
 canadapost_pickup_response = canadapost_proxy.schedule_pickup(canadapost_pickup_request)
 
-# Parse the response into a Purplship unified Pickup response type
+# Parse the response into a purplship unified Pickup response type
 pickup_response = canadapost_mapper.parse_pickup_response(canadapost_pickup_response)
 
 print(pickup_response)
@@ -112,20 +112,20 @@ print(pickup_response)
 ```
 
 !!! info
-    The example above illustrates a Pickup scheduling but the idea is that all requests made by Purplship follow the same lifecycle:
+    The example above illustrates a Pickup scheduling but the idea is that all requests made by purplship follow the same lifecycle:
 
-    - convert unified Purplship API data into a carrier specific request using the `Mapper`
+    - convert unified purplship API data into a carrier specific request using the `Mapper`
     - send the request to the carrier using the `Proxy`
-    - and parse back the response into a unified Purplship data using the `Mapper`
+    - and parse back the response into a unified purplship data using the `Mapper`
 
 !!! caution
-    Note that Purplship does not raise exceptions when there is a failure during requests but rather always return 
+    Note that purplship does not raise exceptions when there is a failure during requests but rather always return 
     a tuple of a `response` if `successful` with a list of `messages` if any **notes**, **messages** or **errors** 
     in case of `failures` are returned.
 
 ## Fluent API
 
-Once you understand the lifecycle above, you can send any requests supported by Purplship with the same mental model.
+Once you understand the lifecycle above, you can send any requests supported by purplship with the same mental model.
 However, this looks a little verbose. That's why we introduced a Fluent interface to handle this process with fewer lines.
 
 ```python

docs/development/developing.md

@@ -5,7 +5,7 @@
 ## Clone the repo
 
 ```bash
-git clone git@github.com:Purplship/purplship.git
+git clone git@github.com:purplship/purplship.git
 ```
 
 ## Source the `bash` script

docs/development/extending.md

@@ -2,9 +2,9 @@
 
 The question we are most asked is: **How to add a custom carrier?**
 
-We have experimented and studied approximately ~25 shipping carriers API/web services to design the Purplship structure as is.
+We have experimented and studied approximately ~25 shipping carriers API/web services to design the purplship structure as is.
 
-The good news is that making adding a custom carrier easy fits perfectly in Purplship vision.
+The good news is that making adding a custom carrier easy fits perfectly in purplship vision.
 
 !!! caution
     To integrate a custom carrier at this stage, you will need:
@@ -23,8 +23,8 @@ The good news is that making adding a custom carrier easy fits perfectly in Purp
     1. Generate Python data types from the carrier API schemas using the type generators bellow
     2. Package the generated data types as a library in [purplship-carriers](https://github.com/PurplShip/purplship-carriers)
 
-1. Create a Purplship extension package
-    1. Create a new Purplship extension by copying [.templates/carrier](https://github.com/PurplShip/purplship/tree/main/.templates/carrier)
+1. Create a purplship extension package
+    1. Create a new purplship extension by copying [.templates/carrier](https://github.com/PurplShip/purplship/tree/main/.templates/carrier)
         into [extensions/[carrier-name]](https://github.com/PurplShip/purplship/tree/main/extensions)
 
     2. Rename all instance for [carrier] to the appropriate carrier name you are integrating. This must be done for files
@@ -42,37 +42,37 @@ The good news is that making adding a custom carrier easy fits perfectly in Purp
 
 ### Extension anatomy 
 
-Considering the vision we aimed to achieve with Purplship, the codebase has been modularized with a clear separation of
+Considering the vision we aimed to achieve with purplship, the codebase has been modularized with a clear separation of
 concerns to decouple clearly the carrier integration from the integration abstraction. Additionally, each carrier
 integration is done in an isolated self-contained package.
 
 As a result, we have a very modular ecosystem where one can only select the carrier integrations of interest without
 carrying the whole codebase.
 
-**Most importantly, this flexibility allows the integration of additional carrier services under the Purplship umbrella.**
+**Most importantly, this flexibility allows the integration of additional carrier services under the purplship umbrella.**
 
 !!! info
-    Purplship makes shipping API integration easy for a single carrier and in a multi-carrier scenario, the benefit
+    purplship makes shipping API integration easy for a single carrier and in a multi-carrier scenario, the benefit
     is exponential.
 
 
 #### Module convention
 
-Two modules are required to create a Purplship extension.
+Two modules are required to create a purplship extension.
 
 !!! abstract "`purplship.mappers.[carrier_name]`"
-    This is where the Purplship abstract classes are implemented. Also, the Metadata require to identified
+    This is where the purplship abstract classes are implemented. Also, the Metadata require to identified
     the extension is also provided there.
 
     > on runtime, purplship retrieves all mappers by going trought the `purplship.mappers` modules
 
 !!! abstract "`purplship.providers.[carrier_name]`"
-    This is where the mapping between Purplship Unified API data is mapped on the carrier data type corresponding requests
+    This is where the mapping between purplship Unified API data is mapped on the carrier data type corresponding requests
 
 #### extension signature
 
-The Mapper is the cornerstone of Purplship's abstraction. A `Metadata` declared at `purplship.mappers.[carrier_name].__init__`
-specifies the integration classes required to define a Purplship compatible extension.
+The Mapper is the cornerstone of purplship's abstraction. A `Metadata` declared at `purplship.mappers.[carrier_name].__init__`
+specifies the integration classes required to define a purplship compatible extension.
 
 ```text
 from purplship.core.metadata import Metadata
@@ -150,7 +150,7 @@ The mapper function implementations consists of instantiating carrier specific r
 === "Mapper"
 
     ```python
-    # Import Purplship unified API models
+    # Import purplship unified API models
     from purplship.core.models import PickupRequest
 
     # Import requirements from the DHL generated data types library (py-dhl) 
@@ -271,7 +271,7 @@ The mapper function implementations consists of instantiating carrier specific r
 
 ### Generated schema data types
 
-To keep to robustness and simplify the maintenance of the codebase, In Purplship, we use Python data types reflecting
+To keep to robustness and simplify the maintenance of the codebase, In purplship, we use Python data types reflecting
 the schemas of carriers we want to integrate.
 That said, defining every schema object's structure can be tedious, long and unproductive. Therefore, code generators
 are used to generate Python data types based of the schema format definition.
@@ -305,7 +305,7 @@ to define yours.
 #### Multi requests
 
 Generally, the carrier web services expose one API endpoint to accomplish most operations describe supported by
-the Purplship unified interface. In some case, more than one API call are required to fulfil certain operation.
+the purplship unified interface. In some case, more than one API call are required to fulfil certain operation.
 
 ##### Abstraction
 

docs/guide/address.md

@@ -97,27 +97,3 @@ request = purplship.Address.validate(
 
 tracking_details_list, messages = request.from_(carrier_gateway).parse()
 ```
-
-???+ check "Tracking output"
-
-    ```python
-    print(tracking_details_list)
-    # [
-    #     TrackingDetails(
-    #         carrier_name="canadapost",
-    #         carrier_id="canadapost",
-    #         tracking_number="7023210039414604",
-    #         events=[
-    #             TrackingEvent(
-    #                 date="2011-04-04",
-    #                 description="Order information received by Canada Post",
-    #                 location="",
-    #                 code="INDUCTION",
-    #                 time="13:34",
-    #                 signatory="",
-    #             )
-    #         ],
-    #         delivered=None,
-    #     )
-    # ]
-    ```