├── .gitignore ├── app ├── static │ ├── USPSIMBStandard.ttf │ └── style.css ├── __main__.py ├── config.py.sample ├── __init__.py ├── templates │ ├── envelope.html │ ├── generate.html │ ├── avery8163.html │ ├── tracking.html │ ├── envelopepdf.html │ └── index.html ├── views.py ├── imb.py └── usps_api.py ├── docker-compose.yml ├── requirements.txt ├── Dockerfile ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode/ 2 | __pycache__/ 3 | config.py -------------------------------------------------------------------------------- /app/static/USPSIMBStandard.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/1997cui/envelope/HEAD/app/static/USPSIMBStandard.ttf -------------------------------------------------------------------------------- /app/__main__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | from . import app 3 | 4 | if __name__ == "__main__": 5 | app.run(debug=True, host='0.0.0.0') -------------------------------------------------------------------------------- /app/config.py.sample: -------------------------------------------------------------------------------- 1 | MAILER_ID = 123456789 2 | SRV_TYPE=40 3 | BARCODE_ID=0 4 | BSG_USERNAME="Alice" 5 | BSG_PASSWD="Your BSG Password" 6 | FLASK_SESSION_KEY="Very secret key" 7 | USPS_WEBAPI_USERNAME="USPS Web API Username" 8 | USPS_NEWAPI_CUSTOMER_ID = "abc" 9 | USPS_NEWAPI_CUSTOMER_SECRET = "def" 10 | REDIS_HOST="localhost" 11 | TRUSTED_HOST=["172.20.0.1"] -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | services: 2 | app: 3 | build: . 4 | ports: 5 | - "8084:8080" 6 | depends_on: 7 | - redis 8 | dns: 9 | - 8.8.8.8 10 | - 8.8.4.4 11 | environment: 12 | - TZ=America/Los_Angeles 13 | restart: always 14 | 15 | redis: 16 | image: "redis:latest" 17 | environment: 18 | - TZ=America/Los_Angeles 19 | restart: always -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | async-timeout==4.0.3 2 | autopep8==2.0.4 3 | backports.tarfile==1.2.0 4 | httptools==0.6.4 5 | httpx==0.25.0 6 | importlib-metadata==8.0.0 7 | jaraco.collections==5.1.0 8 | lazy-object-proxy==1.9.0 9 | pdfkit==1.0.0 10 | pip-autoremove==0.10.0 11 | pip-chill==1.0.3 12 | pylint==3.0.1 13 | python-dotenv==1.0.0 14 | pyyaml==6.0.1 15 | quart==0.20.0 16 | redis==5.0.8 17 | rfc3986==2.0.0 18 | toml==0.10.2 19 | tomli==2.0.1 20 | uvicorn-worker==0.3.0 21 | watchfiles==0.20.0 22 | websockets==15.0.1 23 | wrapt==1.15.0 24 | xmltodict==0.14.2 -------------------------------------------------------------------------------- /app/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from quart import Quart 4 | from quart import Blueprint 5 | 6 | from . import config 7 | app = Quart(__name__) 8 | app.secret_key = config.FLASK_SESSION_KEY 9 | 10 | from . import views 11 | from uvicorn_worker import UvicornWorker 12 | 13 | 14 | class ConfigurableWorker(UvicornWorker): 15 | """ 16 | Define a UvicornWorker that can be configured by modifying its class attribute. 17 | All of the command line options for uvicorn are potential configuration options 18 | (see https://www.uvicorn.org/settings/ for the complete list). 19 | """ 20 | 21 | #: dict: Set the equivalent of uvicorn command line options as keys. 22 | CONFIG_KWARGS = { 23 | "root_path": "/envelope", 24 | "proxy_headers": True, 25 | } -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # base image 2 | FROM python:3.9-bullseye 3 | 4 | # set working directory 5 | WORKDIR /app 6 | 7 | # copy requirements.txt 8 | COPY requirements.txt . 9 | 10 | # install dependencies 11 | RUN apt-get update 12 | RUN apt-get install -y apt-utils 13 | RUN apt-get install -y wget fonts-liberation fonts-wqy-zenhei fonts-arphic-uming 14 | 15 | RUN pip install --no-cache-dir -r requirements.txt 16 | RUN wget https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6.1-2/wkhtmltox_0.12.6.1-2.bullseye_amd64.deb 17 | RUN apt-get install -y ./wkhtmltox_0.12.6.1-2.bullseye_amd64.deb 18 | 19 | # copy source code 20 | COPY . . 21 | 22 | EXPOSE 8080 23 | 24 | CMD ["gunicorn", "app:app", "--workers", "4", "--worker-class", "app.ConfigurableWorker", "--bind", "0.0.0.0:8080", "--forwarded-allow-ips","*"] 25 | 26 | -------------------------------------------------------------------------------- /app/templates/envelope.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Com-10 Envelope 5 | 6 | 7 | 8 |
9 |
10 | 11 | {% for line in sender_address.split('\n') %} 12 | {{ line }}
13 | {% endfor %} 14 |
15 |
16 | 17 |
18 | {{ barcode|safe }} 19 |
20 |
21 | {{human_readable_bar|safe}} 22 |
23 |
24 | {% for line in recipient_address.split('\n') %} 25 | {{ line }}
26 | {% endfor %} 27 |
28 |
29 |
30 | 31 | 32 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Envelope 2 | --- 3 | A lightweight web service to generate USPS first class mail envelope with a traceable barcode. 4 | ## Features 5 | 1. Generate a ready-to-print envelope pdf and html 6 | 2. Support both #10 Envelope and 4in*2in label 7 | 3. The envelope has a traceable barcode 8 | 4. Show status of your first class mail without certify! 9 | ## Install 10 | ### Generate config 11 | - Move `app/config.py.example` to `app/config.py` 12 | - config your USPS Web Tools API username, Business Gateway username and Password [Guide](https://blog.ctyi.me/%E7%94%9F%E6%B4%BB/2021/06/03/USPS_IV_MTR.html) 13 | 14 | - config a Flask session key 15 | - Config your redis server address 16 | ### Docker 17 | - Modify the docker file to meet your need 18 | - `CMD ["gunicorn", "app:app", "--workers", "4", "--worker-class", "app.ConfigurableWorker", "--bind", "0.0.0.0:8080", "--forwarded-allow-ips",""]` 19 | - Define the path and the port 20 | - `docker-compose up -d` 21 | ### Enjoy 22 | - Open `http://localhost:8080/envelope/` in your browser -------------------------------------------------------------------------------- /app/static/style.css: -------------------------------------------------------------------------------- 1 | * { 2 | box-sizing: border-box; 3 | } 4 | 5 | body { 6 | margin: 0; 7 | } 8 | 9 | @font-face { 10 | font-family: 'USPSIMBStandard'; 11 | src: url('USPSIMBStandard.ttf') format('truetype'); 12 | } 13 | 14 | .envelope { 15 | width: 9.5in; 16 | height: 4.125in; 17 | border: 1px solid black; 18 | padding: 0.25in; 19 | transform-origin: left top; 20 | page-break-after: always; 21 | position: absolute; 22 | } 23 | 24 | .sender-address { 25 | width: 4in; 26 | height: 1.5in; 27 | position: absolute; 28 | } 29 | 30 | .recipient-address { 31 | width: 4in; 32 | height: 2.5in; 33 | position: absolute; 34 | left: 5in; 35 | bottom: 0.625in; 36 | } 37 | 38 | .recipient-address { 39 | width: 4in; 40 | height: 2.5in; 41 | position: absolute; 42 | left: 5in; 43 | bottom: 0.625in; 44 | display: flex; 45 | flex-direction: column; 46 | justify-content: center; 47 | } 48 | 49 | .usps-barcode { 50 | font-family: "USPSIMBStandard"; 51 | font-size: 16pt; 52 | } 53 | 54 | .barcode-humanreadable { 55 | font-size: 10pt; 56 | } -------------------------------------------------------------------------------- /app/templates/generate.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Save your tracking information 8 | 9 | 10 |

Tracking Information

11 |

Serial: {{serial}}

12 |

Receipt ZIP: {{recipient_zip}}

13 | 14 |

Download envelope

15 | Download as HTML 16 |
17 | Download as PDF 18 | 19 |

Download Avery 8163 sticker

20 |
21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 |
29 | 30 | 31 | 32 | 33 | 34 |
35 | 36 | -------------------------------------------------------------------------------- /app/templates/avery8163.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Avery 8163 Shipping Labels 6 | 52 | 53 | 54 |
55 |
56 |
57 | {{ barcode|safe }} 58 |
59 |
60 | {{human_readable_bar|safe}} 61 |
62 |
63 | {% for line in recipient_address.split('\n') %} 64 | {{ line }}
65 | {% endfor %} 66 |
67 |
68 |
69 | 70 | -------------------------------------------------------------------------------- /app/templates/tracking.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Tracking Information 8 | 115 | 116 | 117 | 118 |

Tracking Information

119 |
Loading...
120 |
121 | 122 |
123 | 124 | 125 | -------------------------------------------------------------------------------- /app/templates/envelopepdf.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Envelope 6 | 7 | 69 | 70 |
71 |
72 | 73 | {% for line in sender_address.split('\n') %} 74 | {{ line }}
75 | {% endfor %} 76 |
77 |
78 | 79 |
80 | {{ barcode|safe }} 81 |
82 |
83 | {{human_readable_bar|safe}} 84 |
85 |
86 | {% for line in recipient_address.split('\n') %} 87 | {{ line }}
88 | {% endfor %} 89 |
90 |
91 |
92 | 93 | 94 | -------------------------------------------------------------------------------- /app/templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Envelope Generator by Tianyi 5 | 28 | 70 | 71 | 72 |

Envelope Generator

73 |

Track your stamped letters simply and for free 74 | Star 75 |

76 |
77 |

Generate Envelope

78 |
79 |
80 |
81 | 82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
100 |
101 |
102 | 103 | 104 |
105 |
106 | 107 |

108 | 109 |
110 |
111 | 112 |
113 |

Track Mail

114 |
115 |
116 |
117 |
118 |
119 |
120 | 121 |
122 |
123 | 131 |
132 | 133 |

Usage: Use the "Generate Envelope" section to create a PDF or HTML envelope, optionally, use validate address button to correct the address, remember zip code and serial for tracking.
134 | After mailing the envelope, use the "Track Mail" section to track its status.

135 | 136 | 137 | -------------------------------------------------------------------------------- /app/views.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | import json 3 | from redis import asyncio as aioredis 4 | import asyncio 5 | import pdfkit 6 | 7 | from quart import render_template, request, make_response, jsonify, session, websocket 8 | 9 | from . import imb 10 | from . import config 11 | from . import usps_api 12 | from . import app 13 | 14 | ROLLING_WINDOW = 50 15 | 16 | redis_client = aioredis.Redis(host=config.REDIS_HOST, port=6379, db=0) 17 | 18 | 19 | @app.before_serving 20 | async def server_init(): 21 | async def token_maintain(): 22 | while True: 23 | await usps_api.iv_token_maintain() 24 | await usps_api.new_api_token_maintain() 25 | await asyncio.sleep(5 * 60) 26 | app.add_background_task(token_maintain) 27 | 28 | 29 | @app.after_serving 30 | async def server_shutdown(): 31 | await redis_client.close() 32 | print(app.background_tasks) 33 | 34 | 35 | async def generate_serial(): 36 | today = datetime.datetime.today() 37 | num_days = (today - datetime.datetime(1970, 1, 1)).days 38 | base = num_days % ROLLING_WINDOW 39 | day_key = "serial_" + str(base) 40 | perday_counter = await redis_client.incr(day_key) 41 | if perday_counter >= 9999: 42 | raise ValueError 43 | await redis_client.expire(day_key, 48 * 60 * 60) 44 | return base * 10000 + int(perday_counter) 45 | 46 | 47 | def generate_human_readable(receipt_zip: str, serial: int): 48 | return "{0:02d}-{1:03d}-{2:d}-{3:06d}-{4:s}".format(config.BARCODE_ID, config.SRV_TYPE, config.MAILER_ID, serial, receipt_zip) 49 | 50 | 51 | def query_usps_tracking(receipt_zip: str, serial: int): 52 | barcode = generate_human_readable(receipt_zip, serial) 53 | barcode = barcode.replace('-', '') 54 | app.add_background_task(usps_api.iv_token_maintain) 55 | return usps_api.get_piece_tracking(barcode) 56 | 57 | 58 | @app.route('/') 59 | async def index(): 60 | return await render_template('index.html') 61 | 62 | 63 | @app.route('/generate', methods=['POST']) 64 | async def generate(): 65 | sender_address = (await request.form)['sender_address'] 66 | recipient_name = (await request.form)['recipient_name'] 67 | recipient_company = (await request.form).get('recipient_company', '') 68 | recipient_street = (await request.form)['recipient_street'] 69 | recipient_address2 = (await request.form).get('recipient_address2', '') 70 | recipient_city = (await request.form)['recipient_city'] 71 | recipient_state = (await request.form)['recipient_state'] 72 | try: 73 | recipient_zip = int((await request.form)['recipient_zip']) 74 | recipient_zip = str((await request.form)['recipient_zip']) 75 | except ValueError: 76 | response = "Recipient zip is not number!" 77 | return response 78 | if len(str((await request.form)['recipient_zip'])) < 5: 79 | response = "Invalid recipient zip" 80 | return response 81 | zip_full = zip5 = str((await request.form)['recipient_zip'])[:5] 82 | if len(str((await request.form)['recipient_zip'])) > 5: 83 | zip4 = str((await request.form)['recipient_zip'])[5:9] 84 | zip_full = f"{zip5}-{zip4}" 85 | recipient_address_parts = [ 86 | recipient_name, 87 | recipient_company, 88 | recipient_street, 89 | recipient_address2, 90 | f"{recipient_city}, {recipient_state}, {zip_full}" 91 | ] 92 | recipient_address = '\n'.join(filter(bool, recipient_address_parts)) 93 | serial = await generate_serial() 94 | session['sender_address'] = sender_address 95 | session['recipient_address'] = recipient_address 96 | session['serial'] = serial 97 | session['recipient_zip'] = str((await request.form)['recipient_zip']) 98 | return await render_template('generate.html', serial=serial, recipient_zip=recipient_zip) 99 | 100 | 101 | @app.route('/download//') 102 | async def download(format_type: str, doc_type: str): 103 | sender_address = session['sender_address'] 104 | recipient_address = session['recipient_address'] 105 | serial = session['serial'] 106 | recipient_zip = session['recipient_zip'] 107 | human_readable_bar = generate_human_readable(recipient_zip, serial) 108 | row = request.args.get('row', default=1, type=int) 109 | col = request.args.get('col', default=1, type=int) 110 | barcode = imb.encode(config.BARCODE_ID, config.SRV_TYPE, 111 | config.MAILER_ID, serial, str(recipient_zip)) 112 | 113 | if format_type == 'envelope': 114 | template_name = 'envelopepdf.html' 115 | 116 | elif format_type == 'avery': 117 | template_name = 'avery8163.html' 118 | 119 | else: 120 | return "Format type not valid" 121 | 122 | html = await render_template(template_name, sender_address=sender_address, recipient_address=recipient_address, 123 | human_readable_bar=human_readable_bar, barcode=barcode, row=row, col=col) 124 | 125 | if doc_type == 'html': 126 | return html 127 | elif doc_type == 'pdf': 128 | if format_type == 'envelope': 129 | options = { 130 | 'page-height': '4.125in', 131 | 'page-width': '9.5in', 132 | 'margin-bottom': '0in', 133 | 'margin-top': '0in', 134 | 'margin-left': '0in', 135 | 'margin-right': '0in', 136 | 'disable-smart-shrinking': '', 137 | } 138 | elif format_type == 'avery': 139 | options = { 140 | 'page-height': '11in', 141 | 'page-width': '8.5in', 142 | 'margin-bottom': '0in', 143 | 'margin-top': '0in', 144 | 'margin-left': '0in', 145 | 'margin-right': '0in', 146 | 'disable-smart-shrinking': '', 147 | } 148 | 149 | pdf = pdfkit.from_string(html, False, options=options) 150 | response = await make_response(pdf) 151 | response.headers['Content-Type'] = 'application/pdf' 152 | response.headers['Content-Disposition'] = f'attachment; filename={format_type}_{serial:06d}_{recipient_zip:s}.pdf' 153 | return response 154 | else: 155 | return "Document type not valid" 156 | 157 | 158 | @app.route('/tracking', methods=['GET']) 159 | async def tracking(): 160 | return await render_template("tracking.html") 161 | 162 | 163 | @app.websocket('/track-ws') 164 | async def track_ws(): 165 | while True: 166 | try: 167 | req = await websocket.receive_json() 168 | receipt_zip = req['receipt_zip'] 169 | serial = req['serial'] 170 | serial = int(serial) 171 | barcode = f"{config.BARCODE_ID:02d}" + f"{config.SRV_TYPE:03d}" + \ 172 | str(config.MAILER_ID) + f"{serial:06d}" + str(receipt_zip) 173 | except (ValueError, TypeError): 174 | await websocket.send('Invalid input received on WebSocket.') 175 | continue 176 | tracking_data = await usps_api.get_piece_tracking(barcode) 177 | try: 178 | if tracking_data.get('data') and 'imb' in tracking_data['data']: 179 | imb_data_key = f'imb:{tracking_data["data"]["imb"]}' # type: ignore 180 | stored_scans_data = await redis_client.lrange(imb_data_key, 0, -1) # pyright: ignore [reportGeneralTypeIssues] 181 | if 'scans' not in tracking_data['data']: 182 | tracking_data['data']['scans'] = [] # type: ignore 183 | for stored_scan in stored_scans_data: 184 | tracking_data['data']['scans'] = [json.loads( # type: ignore 185 | stored_scan)] + tracking_data['data']['scans'] # type: ignore 186 | except (KeyError, ValueError): 187 | pass 188 | await websocket.send_json(tracking_data) 189 | 190 | 191 | @app.route('/validate_address', methods=['POST']) 192 | async def validate_address(): 193 | zip_full = str((await request.form)['zip']).replace('-', '') 194 | zip5 = zip_full[:5] 195 | address = { 196 | 'street_address': (await request.form)['street_address'], 197 | 'address2': (await request.form)['address2'], 198 | 'city': (await request.form)['city'], 199 | 'state': (await request.form)['state'], 200 | 'zip5': zip5, 201 | } 202 | if len(zip_full) >= 9: 203 | address['zip4'] = zip_full[5:9] 204 | if len(zip_full) >= 11: 205 | address['dp'] = zip_full[9:11] 206 | if len((await request.form)['firmname']) > 0: 207 | address['firmname'] = (await request.form)['firmname'] 208 | standardized_address = await usps_api.get_USPS_standardized_address_new(address) 209 | if standardized_address.get('zip4', None) is None: 210 | standardized_address['zip4']='' 211 | return jsonify(standardized_address) 212 | 213 | 214 | @app.route('/usps_feed', methods=['POST']) 215 | async def usps_feed(): 216 | data = await request.get_json() 217 | 218 | if data is None or 'events' not in data: 219 | return "Invalid data format." 220 | 221 | for event in data['events']: 222 | if 'imb' not in event: 223 | continue 224 | handle_event_type = event.get('handlingEventType', None) 225 | if handle_event_type is None or handle_event_type != 'L': 226 | continue 227 | barcode = event['imb'] 228 | reformed_event = { 229 | 'scan_date_time': event.get('scanDatetime', None), 230 | 'scan_event_code': event.get('scanEventCode', None), 231 | 'handling_event_type': event.get('handlingEventType', None), 232 | 'mail_phase': event.get('mailPhase', None), 233 | 'machine_name': event.get('machineName', None), 234 | 'scanner_type': event.get('scannerType', None), 235 | 'scan_facility_name': event.get('scanFacilityName', None), 236 | 'scan_facility_locale_key': event.get('scanLocaleKey', None), 237 | 'scan_facility_city': event.get('scanFacilityCity', None), 238 | 'scan_facility_state': event.get('scanFacilityState', None), 239 | 'scan_facility_zip': event.get('scanFacilityZip', None) 240 | } 241 | 242 | redis_key = f'imb:{barcode}' 243 | await redis_client.rpush(redis_key, json.dumps(reformed_event)) # pyright: ignore [reportGeneralTypeIssues] 244 | ttl_seconds = 60 * 24 * 60 * 60 245 | await redis_client.expire(redis_key, ttl_seconds) 246 | return "Data stored in Redis." 247 | -------------------------------------------------------------------------------- /app/imb.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- Mode: Python -*- 3 | 4 | # License: Simplified BSD. 5 | # http://www.opensource.org/licenses/bsd-license.html 6 | 7 | # Python implementation of the "Intelligent Mail Barcode", the 8 | # new[ish] U.S. standard for postal barcode encoding. 9 | 10 | # The 'letter encoding' is thus: 11 | # 'A' == Ascender 12 | # 'D' == Descender 13 | # 'F' == Full/Both 14 | # 'T' == Neither 15 | # 16 | # F A D T 17 | # | | 18 | # | | | | 19 | # | | 20 | 21 | # To print the actual code, download the USPSIMBStandard font 22 | # https://ribbs.usps.gov/onecodesolution/download.cfm 23 | # Then use your web browser to print the html generated by the '-h' option. 24 | 25 | # https://ribbs.usps.gov/intelligentmail_mailpieces/documents/tech_guides/SPUSPSG.pdf 26 | 27 | import sys 28 | 29 | W = sys.stderr.write 30 | 31 | # Note: this could probably be written much more simply... 32 | def crc11 (input): 33 | gen_poly = 0x0f35 34 | FCS = 0x07ff 35 | data = input[0] << 5 36 | pos = 1 37 | # do the most significant byte skipping the 2 most significant bits 38 | for bit in range (2, 8): 39 | if (FCS ^ data) & 0x400: 40 | FCS = (FCS << 1) ^ gen_poly 41 | else: 42 | FCS = FCS << 1 43 | FCS &= 0x7ff 44 | data <<= 1 45 | # do the rest of the bytes 46 | for byte_index in range (1, 13): 47 | data = input[byte_index] << 3 48 | for bit in range (8): 49 | if (FCS ^ data) & 0x400: 50 | FCS = (FCS << 1) ^ gen_poly 51 | else: 52 | FCS = FCS << 1 53 | FCS &= 0x7ff 54 | data <<= 1 55 | return FCS 56 | 57 | def reverse_int16 (input): 58 | reverse = 0 59 | for i in range (16): 60 | reverse <<= 1 61 | reverse |= input & 1 62 | input >>= 1 63 | return reverse 64 | 65 | # no clue what this code actually does, it's not explained in the source. 66 | # I assume it's doing some kind of pre-computed table for a hamming code? 67 | def init_n_of_13 (n, table_length): 68 | table = {} 69 | index_low = 0 70 | index_hi = table_length - 1 71 | for i in range (8192): 72 | bit_count = bin(i).count('1') 73 | # If we don't have the right number of bits on, go on to the next value 74 | if bit_count != n: 75 | continue 76 | # If the reverse is less than count, we have already visited this pair before 77 | reverse = reverse_int16(i) >> 3 78 | if reverse < i: 79 | continue 80 | # If Count is symmetric, place it at the first free slot from the end of the 81 | # list. Otherwise, place it at the first free slot from the beginning of the 82 | # list AND place Reverse at the next free slot from the beginning of the list 83 | if i == reverse: 84 | table[index_hi] = i 85 | index_hi -= 1 86 | else: 87 | table[index_low] = i 88 | index_low += 1 89 | table[index_low] = reverse 90 | index_low += 1 91 | # Make sure the lower and upper parts of the table meet properly 92 | if index_low != index_hi + 1: 93 | raise ValueError (index_low, index_hi) 94 | return table 95 | 96 | def make_inverted_tabs(): 97 | global inverted 98 | inverted = {} 99 | for k, v in tab5.items(): 100 | if v in inverted: 101 | raise ValueError 102 | inverted[v] = (0, k) 103 | for k, v in tab2.items(): 104 | if v in inverted: 105 | raise ValueError 106 | inverted[v] = (1, k) 107 | 108 | def binary_to_codewords (n): 109 | r = [] 110 | n, x = divmod (n, 636) 111 | r.append (x) 112 | for i in range (9): 113 | n, x = divmod (n, 1365) 114 | r.append (x) 115 | r.reverse() 116 | return r 117 | 118 | def codewords_to_binary (codes): 119 | n = 0 120 | cr = codes[:] 121 | for code in cr[:-1]: 122 | n = (n * 1365) + code 123 | n = (n * 636) + cr[-1] 124 | return n 125 | 126 | def convert_routing_code (zip): 127 | if len(zip) == 0: 128 | return 0 129 | elif len(zip) == 5: 130 | return int(zip) + 1 131 | elif len(zip) == 9: 132 | return int(zip) + 100000 + 1 133 | elif len(zip) == 11: 134 | return int(zip) + 1000000000 + 100000 + 1 135 | else: 136 | raise ValueError (zip) 137 | 138 | def unconvert_routing_code (n): 139 | if n > 1000000000: 140 | return n - (1000000000 + 100000 + 1) 141 | elif n > 100000: 142 | return n - (100000 + 1) 143 | elif n: 144 | return n - 1 145 | else: 146 | return 0 147 | 148 | def convert_tracking_code (enc, track): 149 | assert (len (track) == 20) 150 | enc = (enc * 10) + int(track[0]) 151 | enc = (enc * 5) + int(track[1]) 152 | for i in range (2, 20): 153 | enc = (enc * 10) + int (track[i]) 154 | return enc 155 | 156 | def unconvert_tracking_code (n): 157 | r = [] 158 | for i in range (2, 20): 159 | n, x = divmod (n, 10) 160 | r.append (x) 161 | n, x = divmod (n, 5) 162 | r.append (x) 163 | n, x = divmod (n, 10) 164 | r.append (x) 165 | r.reverse() 166 | return n, ''.join ([str(int(x)) for x in r]) 167 | 168 | def to_bytes (val, nbytes): 169 | r = [] 170 | for i in range (nbytes): 171 | r.append (val & 0xff) 172 | val >>= 8 173 | r.reverse() 174 | return r 175 | 176 | def encode (barcode_id, service_type_id, mailer_id, serial, delivery): 177 | n = convert_routing_code (delivery) 178 | if str(mailer_id)[0] == '9': 179 | tracking = '%02d%03d%09d%06d' % ( 180 | barcode_id, 181 | service_type_id, 182 | mailer_id, 183 | serial 184 | ) 185 | else: 186 | tracking = '%02d%03d%06d%09d' % ( 187 | barcode_id, 188 | service_type_id, 189 | mailer_id, 190 | serial 191 | ) 192 | n = convert_tracking_code (n, tracking) 193 | # convert to bytes for byte-based crc11 fun 194 | fcs = crc11 (to_bytes (n, 13)) 195 | codewords = binary_to_codewords (n) 196 | codewords[9] *= 2 197 | if fcs & (1<<10): 198 | codewords[0] += 659 199 | r = [] 200 | for b in codewords: 201 | if b < 1287: 202 | r.append (tab5[b]) 203 | elif 127 <= b <= 1364: 204 | r.append (tab2[b-1287]) 205 | else: 206 | raise ValueError 207 | for i in range (10): 208 | if fcs & 1< 659: 256 | fcs |= 1<<10 257 | r[0] -= 659 258 | r[9] >>= 1 259 | binary = codewords_to_binary (r) 260 | fcs0 = crc11 (to_bytes (binary, 13)) 261 | decimal = '%020d' % (int (binary),) 262 | a, tracking = unconvert_tracking_code (binary) 263 | routing = unconvert_routing_code (a) 264 | routing = '%d' % (routing,) 265 | print('routing', routing) 266 | if len(routing) == 11: 267 | print('zip %s-%s delivery point %s' % (routing[:5], routing[5:9], routing[9:])) 268 | elif len(routing) == 9: 269 | print('zip %s-%s' % (routing[:5], routing[5:9])) 270 | elif len(routing) == 5: 271 | print('zip %s' % (routing[:5],)) 272 | else: 273 | print('zip: empty') 274 | print('tracking', tracking) 275 | barcode_id = tracking[0:2] 276 | service_type = tracking[2:5] 277 | if tracking[5] == '9': 278 | mailer_id = tracking[5:5+9] 279 | serial = tracking[5+9:5+9+6] 280 | else: 281 | mailer_id = tracking[5:5+6] 282 | serial = tracking[5+6:5+6+9] 283 | print('barcode_id', barcode_id) 284 | print('service_type', service_type) 285 | print('mailer_id', mailer_id) 286 | print('serial', serial) 287 | 288 | def render_ascii (code): 289 | "render the letter sequence into something resembling the actual bar code" 290 | center = ['|'] * 65 291 | blank = [' '] * 65 292 | r = blank[:], center[:], blank[:] 293 | for i in range (65): 294 | if code[i] == 'A': 295 | r[0][i] = '|' 296 | elif code[i] == 'D': 297 | r[2][i] = '|' 298 | elif code[i] == 'F': 299 | r[0][i] = '|' 300 | r[2][i] = '|' 301 | else: 302 | pass 303 | import sys 304 | W = sys.stderr.write 305 | for x in r: 306 | W (''.join (x) + '\n') 307 | 308 | def render_html (code): 309 | sys.stdout.write ( 310 | '\n'.join ([ 311 | '', 312 | ' ', 313 | '', 314 | '', 315 | '', 316 | '

', 317 | code, 318 | '

\n', 319 | ]) 320 | ) 321 | 322 | def process_bar_table(): 323 | "convert the bar table from the spec into something more usable." 324 | global tableA, tableD 325 | tableA = {} 326 | tableD = {} 327 | for i in range (65): 328 | entry = bar_table[i] 329 | i0, d, i1, a = entry.split() 330 | i0 = ord(i0) - 65 331 | i1 = ord(i1) - 65 332 | d = int(d) 333 | a = int(a) 334 | tableD[i] = i0, d 335 | tableA[i] = i1, a 336 | 337 | # last table from the spec, can this be generated? 338 | bar_table = [ 339 | 'H 2 E 3', 'B 10 A 0', 'J 12 C 8', 'F 5 G 11', 'I 9 D 1', 340 | 'A 1 F 12', 'C 5 B 8', 'E 4 J 11', 'G 3 I 10', 'D 9 H 6', 341 | 'F 11 B 4', 'I 5 C 12', 'J 10 A 2', 'H 1 G 7', 'D 6 E 9', 342 | 'A 3 I 6', 'G 4 C 7', 'B 1 J 9', 'H 10 F 2', 'E 0 D 8', 343 | 'G 2 A 4', 'I 11 B 0', 'J 8 D 12', 'C 6 H 7', 'F 1 E 10', 344 | 'B 12 G 9', 'H 3 I 0', 'F 8 J 7', 'E 6 C 10', 'D 4 A 5', 345 | 'I 4 F 7', 'H 11 B 9', 'G 0 J 6', 'A 6 E 8', 'C 1 D 2', 346 | 'F 9 I 12', 'E 11 G 1', 'J 5 H 4', 'D 3 B 2', 'A 7 C 0', 347 | 'B 3 E 1', 'G 10 D 5', 'I 7 J 4', 'C 11 F 6', 'A 8 H 12', 348 | 'E 2 I 1', 'F 10 D 0', 'J 3 A 9', 'G 5 C 4', 'H 8 B 7', 349 | 'F 0 E 5', 'C 3 A 10', 'G 12 J 2', 'D 11 B 6', 'I 8 H 9', 350 | 'F 4 A 11', 'B 5 C 2', 'J 1 E 12', 'I 3 G 6', 'H 0 D 7', 351 | 'E 7 H 5', 'A 12 B 11', 'C 9 J 0', 'G 8 F 3', 'D 10 I 2', 352 | ] 353 | 354 | samples = [ 355 | # example 4 from the spec 356 | "AADTFFDFTDADTAADAATFDTDDAAADDTDTTDAFADADDDTFFFDDTTTADFAAADFTDAADA", 357 | # a business reply card - note the 9-digit mailer id 358 | "FDDAATADTTTFDDADAFFADAFAATFFDDFADFATTAAFDDDDFTTFADFFFDAFFDDFFDDTD", 359 | # the code printed on the USPS spec documents - their address 360 | "FAFFATDATTATFFFFTFTFFDTFFDAFDADTTDFAFDAADFTTDATDTATTDFDDTFFFFFTFD", 361 | ] 362 | 363 | # example 4 from the spec 364 | def t0(): 365 | return encode (1, 234, 567094, 987654321, '01234567891') 366 | 367 | # quasi-real address 368 | def t1(): 369 | return encode (0, 700, 314159, 1, '95008200130') 370 | 371 | def run_tests(): 372 | code = t0() 373 | print(code) 374 | code = t1() 375 | decode (code) 376 | for sample in samples: 377 | render_ascii (sample) 378 | decode (sample) 379 | 380 | process_bar_table() 381 | tab5 = init_n_of_13 (5, 1287) 382 | tab2 = init_n_of_13 (2, 78) 383 | make_inverted_tabs() 384 | 385 | if __name__ == '__main__': 386 | if '-t' in sys.argv: 387 | sys.argv.remove ('-t') 388 | run_tests() 389 | elif '-d' in sys.argv: 390 | sys.argv.remove ('-d') 391 | code = sys.argv[1] 392 | render_ascii (code) 393 | decode (code) 394 | elif '-e' in sys.argv: 395 | sys.argv.remove ('-e') 396 | barcode_id, service_type, mailer, serial, delivery = sys.argv[1:] 397 | code = encode (int(barcode_id), int(service_type), int(mailer), int(serial), delivery) 398 | print(code) 399 | render_ascii (code) 400 | elif '-h' in sys.argv: 401 | sys.argv.remove ('-h') 402 | barcode_id, service_type, mailer, serial, delivery = sys.argv[1:] 403 | code = encode (int(barcode_id), int(service_type), int(mailer), int(serial), delivery) 404 | render_html (code) 405 | else: 406 | import sys 407 | sys.stderr.write ( 408 | "Usage: %s\n" 409 | " -t : run tests\n" 410 | " -d AAFDTDFDT... : decode\n" 411 | " -e barcode-id service-type mailer-id serial delivery : encode to ASCII\n" 412 | " -h barcode-id service-type mailer-id serial delivery : encode to HTML\n" 413 | "\n" 414 | "Example: %s -e 1 700 314159 99999 20500000399\n" 415 | " [that's the White House, 1600 Pennsylvania Ave]\n" 416 | "Note: is 5+4 digits of zip, plus 2 digits of delivery point,\n" 417 | " (usually the last two digits of the street address).\n" % ( 418 | sys.argv[0], sys.argv[0] 419 | ) 420 | ) 421 | 422 | 423 | 424 | -------------------------------------------------------------------------------- /app/usps_api.py: -------------------------------------------------------------------------------- 1 | from urllib.parse import urljoin 2 | import asyncio 3 | import datetime 4 | import time 5 | import sys 6 | import html 7 | import xmltodict 8 | from redis import asyncio as aioredis 9 | import httpx 10 | 11 | from . import config 12 | from . import app 13 | 14 | 15 | USPS_API_URL = "https://services.usps.com" 16 | USPS_SERVICE_API_BASE = "https://iv.usps.com/ivws_api/informedvisapi/" 17 | USPS_ADDRESS_API_URL = 'https://secure.shippingapis.com/ShippingAPI.dll' 18 | USPS_NEW_API_URL_BASE = "https://apis.usps.com/" 19 | 20 | headers = {'Content-type': 'application/json'} 21 | 22 | class AuthorizationTokenError(RuntimeError): 23 | """Exception raised when the authorization token cannot be retrieved from Redis.""" 24 | pass 25 | 26 | redis_client = aioredis.Redis(host=config.REDIS_HOST, port=6379, db=0) 27 | httpx_client = httpx.AsyncClient(timeout=15) 28 | 29 | async def generate_usps_new_api_token(customer_id: str, customer_secret: str): 30 | data = { 31 | "client_id": customer_id, 32 | "client_secret": customer_secret, 33 | "grant_type": "client_credentials" 34 | } 35 | headers_local = { 36 | 'Content-Type': 'application/json' 37 | } 38 | try: 39 | full_url = urljoin(USPS_NEW_API_URL_BASE, "/oauth2/v3/token") 40 | httpx_client = httpx.AsyncClient(timeout=15) 41 | response = await httpx_client.post(full_url, headers=headers_local, json=data) 42 | response.raise_for_status() 43 | except httpx.HTTPError as err: 44 | return {"error": "HTTPError", "error_description": str(err)} 45 | try: 46 | resp_json = response.json() 47 | except ValueError: 48 | return {"error": "ValueError", "error_description": "Invalid JSON response"} 49 | return resp_json 50 | 51 | async def new_api_token_maintain(): 52 | access_token = await redis_client.get("usps_new_api_access_token") 53 | token_expiry_time = await redis_client.get("usps_new_api_access_token_expiry") 54 | now = time.time() 55 | if token_expiry_time is not None: 56 | token_expiry_time = float(token_expiry_time.decode('utf-8')) 57 | if token_expiry_time is None or now >= token_expiry_time: 58 | # Token is expired or absent; obtain a new token 59 | app.logger.info("Trying to get USPS Oauth token from new API") 60 | resp = await generate_usps_new_api_token(config.USPS_NEWAPI_CUSTOMER_ID, config.USPS_NEWAPI_CUSTOMER_SECRET) 61 | if "error" in resp: 62 | app.logger.error(f"Failed to get new token, {resp}") 63 | return 64 | access_token = resp.get('access_token') 65 | if access_token is None: 66 | return 67 | token_type = resp.get('token_type', 'Bearer') 68 | expires_in = int(resp.get('expires_in', -1)) 69 | token_expiry_time = now + expires_in / 2.0 70 | # Store the token and expiry time in Redis 71 | await redis_client.set("usps_new_api_access_token", access_token) 72 | await redis_client.set("usps_new_api_token_type", token_type) 73 | await redis_client.set("usps_new_api_access_token_expiry", token_expiry_time) 74 | 75 | 76 | async def generate_iv_token_usps(username: str, 77 | passwd: str): 78 | data = { 79 | "username": username, 80 | "password": passwd, 81 | "grant_type": "authorization", 82 | "response_type": "token", 83 | "scope": "user.info.ereg,iv1.apis", 84 | "client_id": "687b8a36-db61-42f7-83f7-11c79bf7785e"} 85 | try: 86 | response = await httpx_client.post(urljoin(USPS_API_URL, "oauth/authenticate"), json=data, headers=headers) 87 | except httpx.HTTPError as err: 88 | return {"error": "HTTPError", "error_description": str(err)} 89 | try: 90 | response = response.json() 91 | except ValueError: 92 | return {"error": "ValueError", "error_description": "Invalid JSON"} 93 | return response 94 | 95 | 96 | async def refresh_iv_token_usps(refresh_token: str): 97 | data = { 98 | "refresh_token": refresh_token, 99 | "grant_type": "authorization", 100 | "response_type": "token", 101 | "scope": "user.info.ereg,iv1.apis" 102 | } 103 | try: 104 | response = await httpx_client.post(urljoin(USPS_API_URL, "oauth/token"), json=data, headers=headers) 105 | except httpx.HTTPError as err: 106 | return {"error": "HTTPError", "error_description": str(err)} 107 | return response.json() 108 | 109 | 110 | async def iv_token_maintain(): 111 | access_token = await redis_client.get("usps_access_token") 112 | next_refresh_time = await redis_client.get("usps_token_nextrefresh") 113 | refresh_token = await redis_client.get("usps_refresh_token") 114 | now = datetime.datetime.now() 115 | if next_refresh_time is not None: 116 | next_refresh_time = datetime.datetime.fromtimestamp( 117 | float(next_refresh_time.decode('utf-8'))) 118 | if next_refresh_time is None or now > next_refresh_time: 119 | resp = await generate_iv_token_usps(config.BSG_USERNAME, config.BSG_PASSWD) 120 | if "error" in resp: 121 | return 122 | token_type = resp['token_type'] 123 | access_token = resp['access_token'] 124 | refresh_token = resp['refresh_token'] 125 | expires_in = int(resp['expires_in']) 126 | refresh_token = resp['refresh_token'] 127 | await redis_client.set("usps_access_token", access_token) 128 | await redis_client.set("usps_token_nextrefresh", time.time() + expires_in/2.0) 129 | await redis_client.set("usps_refresh_token", refresh_token) 130 | await redis_client.set("usps_token_type", token_type) 131 | else: 132 | refresh_token = refresh_token.decode('utf-8') 133 | resp = await refresh_iv_token_usps(refresh_token) 134 | if "error" in resp: 135 | return 136 | token_type = resp['token_type'] 137 | access_token = resp['access_token'] 138 | expires_in = int(resp['expires_in']) 139 | await redis_client.set("usps_access_token", access_token) 140 | await redis_client.set("usps_token_type", token_type) 141 | await redis_client.set("usps_token_nextrefresh", time.time() + expires_in/2.0) 142 | 143 | 144 | async def get_iv_authorization_header(): 145 | next_refresh_time = await redis_client.get("usps_token_nextrefresh") 146 | if next_refresh_time is not None: 147 | next_refresh_time = datetime.datetime.fromtimestamp( 148 | float(next_refresh_time.decode('utf-8'))) 149 | now = datetime.datetime.now() 150 | if next_refresh_time is None or now > next_refresh_time: 151 | await iv_token_maintain() 152 | access_token = (await redis_client.get("usps_access_token")).decode('utf-8') 153 | token_type = (await redis_client.get("usps_token_type")).decode('utf-8') 154 | headers_local = dict() 155 | headers_local["Authorization"] = token_type + " " + access_token 156 | return headers_local 157 | 158 | async def get_new_api_authorization_header(): 159 | try: 160 | token_expiry_time = await redis_client.get("usps_new_api_access_token_expiry") 161 | if token_expiry_time is not None: 162 | token_expiry_time = float(token_expiry_time.decode('utf-8')) 163 | now = time.time() 164 | if token_expiry_time is None or now >= token_expiry_time: 165 | await new_api_token_maintain() 166 | access_token = await redis_client.get("usps_new_api_access_token") 167 | token_type = await redis_client.get("usps_new_api_token_type") 168 | 169 | if not access_token or not token_type: 170 | app.logger.error("Unable to obtain USPS Address API access token") 171 | raise AuthorizationTokenError("Unable to obtain USPS Address API access token") 172 | 173 | headers_local = { 174 | "Authorization": f"{token_type.decode('utf-8')} {access_token.decode('utf-8')}" 175 | } 176 | return headers_local 177 | except Exception as e: 178 | app.logger.exception("Exception occurred in get_address_authorization_header") 179 | raise 180 | 181 | 182 | async def get_piece_tracking(imb: str): 183 | url = urljoin(USPS_SERVICE_API_BASE, "api/mt/get/piece/imb/" + imb) 184 | try: 185 | response = await httpx_client.get(url, headers=await get_iv_authorization_header()) 186 | except httpx.HTTPError as err: 187 | return {"error": "HTTPError", "error_description": str(err)} 188 | return response.json() 189 | 190 | 191 | async def get_USPS_standardized_address(address): 192 | req = "" 193 | if 'firmname' in address: 194 | req += f"{address['firmname']}" 195 | req += str(f""" 196 | {address['address2']} 197 | {address['street_address']} 198 | {address['city']} 199 | {address['state']} 200 | {address['zip5']} 201 | """) 202 | if 'zip4' in address: 203 | req += f"{address['zip4']}" 204 | else: 205 | req += "" 206 | 207 | address_xml = f""" 208 |
{req}
209 | """ 210 | 211 | request_xml = f""" 212 | 213 | 1 214 | {address_xml} 215 | 216 | """ 217 | try: 218 | response = await httpx_client.get(USPS_ADDRESS_API_URL, params={'API': 'Verify', 'XML': request_xml}) 219 | except httpx.HTTPError as err: 220 | return {"error": "HTTPError", "error_description": str(err)} 221 | response_dict = xmltodict.parse(response.content) 222 | 223 | if 'Error' in response_dict: 224 | return {'error': html.unescape(response_dict['Error']['Description'])} 225 | 226 | if 'Error' in response_dict['AddressValidateResponse']['Address']: 227 | return {'error': html.unescape(response_dict['AddressValidateResponse']['Address']['Error']['Description'])} 228 | 229 | if 'Address1' not in response_dict['AddressValidateResponse']['Address']: 230 | response_dict['AddressValidateResponse']['Address']['Address1'] = '' 231 | if 'FirmName' not in response_dict['AddressValidateResponse']['Address']: 232 | response_dict['AddressValidateResponse']['Address']['FirmName'] = '' 233 | standardized_address = { 234 | 'firmname': response_dict['AddressValidateResponse']['Address']['FirmName'], 235 | 'address2': response_dict['AddressValidateResponse']['Address']['Address1'], 236 | 'street_address': response_dict['AddressValidateResponse']['Address']['Address2'], 237 | 'city': response_dict['AddressValidateResponse']['Address']['City'], 238 | 'state': response_dict['AddressValidateResponse']['Address']['State'], 239 | 'zip5': response_dict['AddressValidateResponse']['Address']['Zip5'], 240 | 'zip4': response_dict['AddressValidateResponse']['Address']['Zip4'], 241 | 'dp': response_dict['AddressValidateResponse']['Address'].get('DeliveryPoint', ''), 242 | } 243 | 244 | return standardized_address 245 | 246 | 247 | async def get_USPS_standardized_address_new(address): 248 | params = { 249 | 'firm': address.get("firmname", ''), 250 | 'streetAddress': address.get('street_address', ''), 251 | 'secondaryAddress': address.get('address2', ''), 252 | 'city': address.get('city', ''), 253 | 'state': address.get('state', ''), 254 | 'ZIPCode': address.get('zip5', ''), 255 | 'ZIPPlus4': address.get('zip4', ''), 256 | } 257 | 258 | # Clean up empty parameters 259 | params = {k: v for k, v in params.items() if v} 260 | 261 | try: 262 | headers = await get_new_api_authorization_header() 263 | headers['accept'] = 'application/json' 264 | 265 | response = await httpx_client.get( 266 | urljoin(USPS_NEW_API_URL_BASE, '/addresses/v3/address'), 267 | headers=headers, 268 | params=params 269 | ) 270 | response.raise_for_status() 271 | except httpx.HTTPStatusError as exc: 272 | if exc.response.status_code == 401: 273 | # Unauthorized; attempt to refresh the token and retry once 274 | app.logger.warning("Unauthorized response, refreshing access token and retrying") 275 | await new_api_token_maintain() 276 | headers = await get_new_api_authorization_header() 277 | response = await httpx_client.get( 278 | urljoin(USPS_NEW_API_URL_BASE, '/addresses/v3/address'), 279 | headers=headers, 280 | params=params 281 | ) 282 | response.raise_for_status() 283 | else: 284 | app.logger.error(f"HTTP error occurred: {exc}") 285 | return {"error": "HTTPError", "error_description": str(exc)} 286 | except Exception as exc: 287 | app.logger.exception("Exception occurred in get_USPS_standardized_address_new") 288 | return {"error": "Exception", "error_description": str(exc)} 289 | 290 | try: 291 | response_data = response.json() 292 | except ValueError: 293 | app.logger.error("ValueError: Invalid JSON response from USPS Address API") 294 | return {"error": "ValueError", "error_description": "Invalid JSON response"} 295 | 296 | if 'errors' in response_data: 297 | app.logger.error(f"Error response from USPS Address API: {response_data['errors']}") 298 | return {'error': response_data['errors']} 299 | 300 | # Extract the standardized address components 301 | address_info = response_data.get('address', {}) 302 | address_additional_info = response_data.get('additionalInfo', {}) 303 | firm = response_data.get('firm', '') 304 | 305 | # Build the standardized address dictionary 306 | standardized_address = { 307 | 'firmname': firm, 308 | 'street_address': address_info.get('streetAddress', ''), 309 | 'address2': address_info.get('secondaryAddress', ''), 310 | 'city': address_info.get('city', ''), 311 | 'state': address_info.get('state', ''), 312 | 'zip5': address_info.get('ZIPCode', ''), 313 | 'zip4': address_info.get('ZIPPlus4', ''), 314 | 'dp': address_additional_info.get('deliveryPoint', ''), 315 | } 316 | return standardized_address 317 | 318 | if __name__ == "__main__": 319 | loop = asyncio.get_event_loop() 320 | print(loop.run_until_complete(get_piece_tracking(sys.argv[1]))) 321 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------