openitinerary 0.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. openitinerary-0.1.1/LICENSE +201 -0
  2. openitinerary-0.1.1/PKG-INFO +175 -0
  3. openitinerary-0.1.1/README.md +146 -0
  4. openitinerary-0.1.1/pyproject.toml +62 -0
  5. openitinerary-0.1.1/pyproject.toml.orig +56 -0
  6. openitinerary-0.1.1/src/openitinerary/__init__.py +43 -0
  7. openitinerary-0.1.1/src/openitinerary/adapters/__init__.py +46 -0
  8. openitinerary-0.1.1/src/openitinerary/adapters/agent.py +80 -0
  9. openitinerary-0.1.1/src/openitinerary/adapters/api/adapt.py +70 -0
  10. openitinerary-0.1.1/src/openitinerary/adapters/api/main.py +13 -0
  11. openitinerary-0.1.1/src/openitinerary/adapters/api/test_adapt.py +122 -0
  12. openitinerary-0.1.1/src/openitinerary/adapters/email_adapter.py +46 -0
  13. openitinerary-0.1.1/src/openitinerary/adapters/html_adapter.py +70 -0
  14. openitinerary-0.1.1/src/openitinerary/adapters/main.py +61 -0
  15. openitinerary-0.1.1/src/openitinerary/adapters/pdf.py +33 -0
  16. openitinerary-0.1.1/src/openitinerary/adapters/test_email_adapter.py +77 -0
  17. openitinerary-0.1.1/src/openitinerary/adapters/test_html_adapter.py +76 -0
  18. openitinerary-0.1.1/src/openitinerary/adapters/test_pdf.py +53 -0
  19. openitinerary-0.1.1/src/openitinerary/models/common.py +42 -0
  20. openitinerary-0.1.1/src/openitinerary/models/domains/accommodation.py +21 -0
  21. openitinerary-0.1.1/src/openitinerary/models/domains/activity.py +48 -0
  22. openitinerary-0.1.1/src/openitinerary/models/domains/flight.py +26 -0
  23. openitinerary-0.1.1/src/openitinerary/models/domains/test_accommodation.py +82 -0
  24. openitinerary-0.1.1/src/openitinerary/models/domains/test_activity.py +180 -0
  25. openitinerary-0.1.1/src/openitinerary/models/domains/test_flight.py +71 -0
  26. openitinerary-0.1.1/src/openitinerary/models/domains/test_train.py +66 -0
  27. openitinerary-0.1.1/src/openitinerary/models/domains/train.py +16 -0
  28. openitinerary-0.1.1/src/openitinerary/models/domains/transfer.py +22 -0
  29. openitinerary-0.1.1/src/openitinerary/models/itinerary.py +29 -0
  30. openitinerary-0.1.1/src/openitinerary/models/place.py +34 -0
  31. openitinerary-0.1.1/src/openitinerary/models/places.py +9 -0
  32. openitinerary-0.1.1/src/openitinerary/models/segment_type.py +19 -0
  33. openitinerary-0.1.1/src/openitinerary/models/segments.py +38 -0
  34. openitinerary-0.1.1/src/openitinerary/models/test_common.py +142 -0
  35. openitinerary-0.1.1/src/openitinerary/models/test_itinerary.py +98 -0
  36. openitinerary-0.1.1/src/openitinerary/models/test_place.py +75 -0
  37. openitinerary-0.1.1/src/openitinerary/models/test_segments.py +84 -0
  38. openitinerary-0.1.1/src/openitinerary/models/test_transfer.py +86 -0
  39. openitinerary-0.1.1/src/openitinerary/test_version.py +54 -0
  40. openitinerary-0.1.1/src/openitinerary/version.py +39 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,175 @@
1
+ Metadata-Version: 2.4
2
+ Name: openitinerary
3
+ Version: 0.1.1
4
+ Summary: OpenItinerary is an open, vendor-neutral standard for representing travel itineraries as structured data.
5
+ Keywords: itinerary,open,standard,travel,flight,mcp
6
+ Author: kiran94
7
+ License-Expression: Apache-2.0
8
+ License-File: LICENSE
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Topic :: Utilities
12
+ Classifier: Topic :: Software Development
13
+ Classifier: Topic :: Software Development :: Version Control :: Git
14
+ Requires-Dist: pycountry>=26.2.16
15
+ Requires-Dist: pydantic[email]>=2.13.4
16
+ Requires-Dist: pydantic-extra-types>=2.11.1
17
+ Requires-Dist: tzdata>=2026.3
18
+ Requires-Dist: beautifulsoup4>=4.15.0 ; extra == 'adapters'
19
+ Requires-Dist: fastapi[standard]>=0.141.1 ; extra == 'adapters'
20
+ Requires-Dist: pydantic-ai>=2.22.0 ; extra == 'adapters'
21
+ Requires-Dist: pydantic-ai-slim[duckduckgo]>=2.22.0 ; extra == 'adapters'
22
+ Requires-Dist: pypdf>=6.14.2 ; extra == 'adapters'
23
+ Requires-Python: >=3.11
24
+ Project-URL: Homepage, https://pypi.org/project/openitinerary/
25
+ Project-URL: Repository, https://github.com/kiran94/openitinerary
26
+ Project-URL: Documentation, https://github.com/kiran94/openitinerary/blob/main/README.md
27
+ Provides-Extra: adapters
28
+ Description-Content-Type: text/markdown
29
+
30
+ # OpenItinerary
31
+
32
+ [![build](https://github.com/kiran94/openitinerary/actions/workflows/build.yml/badge.svg)](https://github.com/kiran94/openitinerary/actions/workflows/build.yml) ![PyPI Version](https://img.shields.io/pypi/v/openitinerary)
33
+
34
+
35
+ OpenItinerary is an open, vendor-neutral standard for representing travel itineraries as structured data.
36
+
37
+ Inspired by JSON in the data exchange space, OpenItinerary facilitates a common specification that any travel company can produce or consume without relying on proprietary formats. A single itinerary can contain flights, trains, accommodation and other travel related activities from various vendors within a single unified model.
38
+
39
+ Principles:
40
+ * Vendor Neutral: No dependency on any particular vendor proprietary format. Instead model the underlying travel concepts.
41
+ * Open & Interoperable: Designed to move cleanly between systems and programming languages.
42
+ * Strongly Typed: Fields have clear semantics and avoid ambiguity. Missing concept and fields should be proposed to be added to the standard and there should be no custom metadata "escape hatches".
43
+ * Minimal: Universal Concepts are defined at the base models and domain specifics belong in specialized types.
44
+ * Serialization Friendly: Data model will at *minimum* map cleanly to JSON.
45
+ * Versioning: Schema is versioned and follows standard semantic versioning rules.
46
+ * Single Canonical Time: Date/Times are *always* stored in UTC format. Geographic Places will always store the Time zone in which they take place. Downstream applications are responsible for ensuring that time presented correctly.
47
+ * Internationalization: International differences are handled explicitly. Textual fields will store the language they are stored in so that downstream applications can present/provide translation when needed.
48
+
49
+ ## Implementation
50
+
51
+ The schema is defined and maintained using *Pydantic Models* however this does not mean that OpenItinerary is a python project. These models are used to generate a **JSON Schema** which serves as the canonical schema of the project.
52
+
53
+ JSON is the default interchange format because it is universal, readable, and easy to integrate. From this format, other formats can be derived:
54
+
55
+ ```mermaid
56
+ graph LR
57
+
58
+ Pydantic(Pydantic Models)
59
+ JSONSchema(JSON Schema)
60
+
61
+ Pydantic --> JSONSchema
62
+
63
+ JSONSchema --> Typescript
64
+ JSONSchema --> Protobuf
65
+ JSONSchema --> Flatbuffer
66
+ JSONSchema --> ...
67
+ ```
68
+
69
+ *Performance sensitive consumers may want to use binary formats such as Protobuf so the standard only states that JSON is a minimum supported format. Binary formats must represent the same model.*
70
+
71
+ ### Python Package
72
+
73
+ Install the Python package from PyPI:
74
+
75
+ ```bash
76
+ python -m pip install openitinerary
77
+ ```
78
+
79
+ Import models from the `openitinerary` package:
80
+
81
+ ```python
82
+ from openitinerary.models.itinerary import Itinerary
83
+ ```
84
+
85
+ Generate the current JSON Schema with the installed command:
86
+
87
+ ```bash
88
+ openitinerary --output stdout
89
+ ```
90
+
91
+ ### Adapter API configuration
92
+
93
+ The Adapter API limits each uploaded document to 10 MiB by default. Set
94
+ to a positive integer to configure the
95
+ limit in bytes. The value is loaded when the API process starts, so restart the
96
+ process after changing it.
97
+
98
+ #### Environment Variables
99
+
100
+ | Name | Description | Default |
101
+ | -------------------------------------- | -------------------------------------------------------- | ----------------------- |
102
+ | `OPEN_ITINERARY_MAX_UPLOAD_SIZE_BYTES` | Maximum size of an uploaded document to the `/adapt` API | `10485760` bytes (10MB) |
103
+
104
+ ## Concepts
105
+
106
+ * `Itinerary`: An itinerary is an ordered collection of typed segments.
107
+ * `Segment`: A travel activity that happens at a specified time at a specific place.
108
+ * `Place`: A geographical location on the earth.
109
+
110
+ The `BaseSegment` defined common concepts for all travel related activities and domain specific models such as `FlightSegment` add stronger fields and validation.
111
+
112
+ ## Roadmap
113
+
114
+ **Schema**
115
+ - [x] Base Segment Types
116
+ - [x] Flights and Airports
117
+ - [x] Train and Train Stations
118
+ - [x] Accommodation
119
+ - [x] Transfers
120
+ - [x] Activities and Tours
121
+ - [ ] Car Rentals
122
+ - [ ] Ferries
123
+ - [ ] Cruises
124
+
125
+ **Implementations**
126
+ - [x] PDF Adapter
127
+ - [x] HTML Adapter
128
+ - [x] Email Adapter
129
+ - [ ] Calender Adapter
130
+ - [ ] ZIP Adapter
131
+ - [ ] Model Validation API
132
+ - [x] Adapter API
133
+ - [x] Python Package
134
+ - [ ] JSON Schema Package
135
+ - [ ] Batch Ingestion & Job Processing Service
136
+
137
+ ### Versioning and releases
138
+
139
+ This repository has two independent versions:
140
+
141
+ * The **schema version** is defined by `OPEN_ITINERARY_VERSION` in
142
+ `src/openitinerary/version.py`. Changes to the standard must update this
143
+ version in the same pull request and regenerate the committed schemas with
144
+ `make generate_out`.
145
+ * The **Python package version** is defined in `pyproject.toml`. It changes when
146
+ a new Python distribution is published, including releases containing only
147
+ Python tooling or adapter changes. Such changes do not require a schema
148
+ version bump.
149
+
150
+ Schema versions follow semantic versioning. Breaking changes increment the
151
+ major version, backwards-compatible additions increment the minor version, and
152
+ small corrections to schema documentation or metadata increment the patch
153
+ version. Generated schema directories intentionally use only the major and
154
+ minor components, for example `schemas/0.1/itinerary.schema.json`. A patch
155
+ release updates the schema for that minor line rather than creating a new
156
+ directory.
157
+
158
+ Package version changes are made by a developer in a pull request intended to
159
+ create a release. Use `uv version` so `pyproject.toml` and `uv.lock` remain in
160
+ sync, then commit both files:
161
+
162
+ ```bash
163
+ uv version --bump patch --no-sync
164
+ ```
165
+
166
+ Use `minor` or `major` instead of `patch` when appropriate. Pull requests are
167
+ published as beta versions for testing. After a package-version change is
168
+ merged to `main`, the committed version is built and published to PyPI. A merge
169
+ that does not change the package version does not publish a stable release.
170
+
171
+ ## License
172
+
173
+ Copyright 2026 Kiran Patel.
174
+
175
+ Licensed under the [Apache License, Version 2.0](LICENSE).
@@ -0,0 +1,146 @@
1
+ # OpenItinerary
2
+
3
+ [![build](https://github.com/kiran94/openitinerary/actions/workflows/build.yml/badge.svg)](https://github.com/kiran94/openitinerary/actions/workflows/build.yml) ![PyPI Version](https://img.shields.io/pypi/v/openitinerary)
4
+
5
+
6
+ OpenItinerary is an open, vendor-neutral standard for representing travel itineraries as structured data.
7
+
8
+ Inspired by JSON in the data exchange space, OpenItinerary facilitates a common specification that any travel company can produce or consume without relying on proprietary formats. A single itinerary can contain flights, trains, accommodation and other travel related activities from various vendors within a single unified model.
9
+
10
+ Principles:
11
+ * Vendor Neutral: No dependency on any particular vendor proprietary format. Instead model the underlying travel concepts.
12
+ * Open & Interoperable: Designed to move cleanly between systems and programming languages.
13
+ * Strongly Typed: Fields have clear semantics and avoid ambiguity. Missing concept and fields should be proposed to be added to the standard and there should be no custom metadata "escape hatches".
14
+ * Minimal: Universal Concepts are defined at the base models and domain specifics belong in specialized types.
15
+ * Serialization Friendly: Data model will at *minimum* map cleanly to JSON.
16
+ * Versioning: Schema is versioned and follows standard semantic versioning rules.
17
+ * Single Canonical Time: Date/Times are *always* stored in UTC format. Geographic Places will always store the Time zone in which they take place. Downstream applications are responsible for ensuring that time presented correctly.
18
+ * Internationalization: International differences are handled explicitly. Textual fields will store the language they are stored in so that downstream applications can present/provide translation when needed.
19
+
20
+ ## Implementation
21
+
22
+ The schema is defined and maintained using *Pydantic Models* however this does not mean that OpenItinerary is a python project. These models are used to generate a **JSON Schema** which serves as the canonical schema of the project.
23
+
24
+ JSON is the default interchange format because it is universal, readable, and easy to integrate. From this format, other formats can be derived:
25
+
26
+ ```mermaid
27
+ graph LR
28
+
29
+ Pydantic(Pydantic Models)
30
+ JSONSchema(JSON Schema)
31
+
32
+ Pydantic --> JSONSchema
33
+
34
+ JSONSchema --> Typescript
35
+ JSONSchema --> Protobuf
36
+ JSONSchema --> Flatbuffer
37
+ JSONSchema --> ...
38
+ ```
39
+
40
+ *Performance sensitive consumers may want to use binary formats such as Protobuf so the standard only states that JSON is a minimum supported format. Binary formats must represent the same model.*
41
+
42
+ ### Python Package
43
+
44
+ Install the Python package from PyPI:
45
+
46
+ ```bash
47
+ python -m pip install openitinerary
48
+ ```
49
+
50
+ Import models from the `openitinerary` package:
51
+
52
+ ```python
53
+ from openitinerary.models.itinerary import Itinerary
54
+ ```
55
+
56
+ Generate the current JSON Schema with the installed command:
57
+
58
+ ```bash
59
+ openitinerary --output stdout
60
+ ```
61
+
62
+ ### Adapter API configuration
63
+
64
+ The Adapter API limits each uploaded document to 10 MiB by default. Set
65
+ to a positive integer to configure the
66
+ limit in bytes. The value is loaded when the API process starts, so restart the
67
+ process after changing it.
68
+
69
+ #### Environment Variables
70
+
71
+ | Name | Description | Default |
72
+ | -------------------------------------- | -------------------------------------------------------- | ----------------------- |
73
+ | `OPEN_ITINERARY_MAX_UPLOAD_SIZE_BYTES` | Maximum size of an uploaded document to the `/adapt` API | `10485760` bytes (10MB) |
74
+
75
+ ## Concepts
76
+
77
+ * `Itinerary`: An itinerary is an ordered collection of typed segments.
78
+ * `Segment`: A travel activity that happens at a specified time at a specific place.
79
+ * `Place`: A geographical location on the earth.
80
+
81
+ The `BaseSegment` defined common concepts for all travel related activities and domain specific models such as `FlightSegment` add stronger fields and validation.
82
+
83
+ ## Roadmap
84
+
85
+ **Schema**
86
+ - [x] Base Segment Types
87
+ - [x] Flights and Airports
88
+ - [x] Train and Train Stations
89
+ - [x] Accommodation
90
+ - [x] Transfers
91
+ - [x] Activities and Tours
92
+ - [ ] Car Rentals
93
+ - [ ] Ferries
94
+ - [ ] Cruises
95
+
96
+ **Implementations**
97
+ - [x] PDF Adapter
98
+ - [x] HTML Adapter
99
+ - [x] Email Adapter
100
+ - [ ] Calender Adapter
101
+ - [ ] ZIP Adapter
102
+ - [ ] Model Validation API
103
+ - [x] Adapter API
104
+ - [x] Python Package
105
+ - [ ] JSON Schema Package
106
+ - [ ] Batch Ingestion & Job Processing Service
107
+
108
+ ### Versioning and releases
109
+
110
+ This repository has two independent versions:
111
+
112
+ * The **schema version** is defined by `OPEN_ITINERARY_VERSION` in
113
+ `src/openitinerary/version.py`. Changes to the standard must update this
114
+ version in the same pull request and regenerate the committed schemas with
115
+ `make generate_out`.
116
+ * The **Python package version** is defined in `pyproject.toml`. It changes when
117
+ a new Python distribution is published, including releases containing only
118
+ Python tooling or adapter changes. Such changes do not require a schema
119
+ version bump.
120
+
121
+ Schema versions follow semantic versioning. Breaking changes increment the
122
+ major version, backwards-compatible additions increment the minor version, and
123
+ small corrections to schema documentation or metadata increment the patch
124
+ version. Generated schema directories intentionally use only the major and
125
+ minor components, for example `schemas/0.1/itinerary.schema.json`. A patch
126
+ release updates the schema for that minor line rather than creating a new
127
+ directory.
128
+
129
+ Package version changes are made by a developer in a pull request intended to
130
+ create a release. Use `uv version` so `pyproject.toml` and `uv.lock` remain in
131
+ sync, then commit both files:
132
+
133
+ ```bash
134
+ uv version --bump patch --no-sync
135
+ ```
136
+
137
+ Use `minor` or `major` instead of `patch` when appropriate. Pull requests are
138
+ published as beta versions for testing. After a package-version change is
139
+ merged to `main`, the committed version is built and published to PyPI. A merge
140
+ that does not change the package version does not publish a stable release.
141
+
142
+ ## License
143
+
144
+ Copyright 2026 Kiran Patel.
145
+
146
+ Licensed under the [Apache License, Version 2.0](LICENSE).
@@ -0,0 +1,62 @@
1
+ [project]
2
+ name = "openitinerary"
3
+ version = "0.1.1"
4
+ description = "OpenItinerary is an open, vendor-neutral standard for representing travel itineraries as structured data."
5
+ readme = "README.md"
6
+ license = "Apache-2.0"
7
+ license-files = ["LICENSE"]
8
+ requires-python = ">=3.11"
9
+ keywords = [
10
+ "itinerary",
11
+ "open",
12
+ "standard",
13
+ "travel",
14
+ "flight",
15
+ "mcp",
16
+ ]
17
+ classifiers = [
18
+ "Intended Audience :: Developers",
19
+ "Operating System :: OS Independent",
20
+ "Topic :: Utilities",
21
+ "Topic :: Software Development",
22
+ "Topic :: Software Development :: Version Control :: Git",
23
+ ]
24
+ dependencies = [
25
+ "pycountry>=26.2.16",
26
+ "pydantic[email]>=2.13.4",
27
+ "pydantic-extra-types>=2.11.1",
28
+ "tzdata>=2026.3",
29
+ ]
30
+
31
+ [[project.authors]]
32
+ name = "kiran94"
33
+
34
+ [project.optional-dependencies]
35
+ adapters = [
36
+ "beautifulsoup4>=4.15.0",
37
+ "fastapi[standard]>=0.141.1",
38
+ "pydantic-ai>=2.22.0",
39
+ "pydantic-ai-slim[duckduckgo]>=2.22.0",
40
+ "pypdf>=6.14.2",
41
+ ]
42
+
43
+ [project.scripts]
44
+ openitinerary = "openitinerary:main"
45
+
46
+ [project.urls]
47
+ Homepage = "https://pypi.org/project/openitinerary/"
48
+ Repository = "https://github.com/kiran94/openitinerary"
49
+ Documentation = "https://github.com/kiran94/openitinerary/blob/main/README.md"
50
+
51
+ [build-system]
52
+ requires = ["uv_build>=0.11.8,<0.12.0"]
53
+ build-backend = "uv_build"
54
+
55
+ [dependency-groups]
56
+ dev = [
57
+ "pytest>=9.0.3",
58
+ "ruff>=0.15.20",
59
+ ]
60
+
61
+ [tool.ruff]
62
+ line-length = 120
@@ -0,0 +1,56 @@
1
+ [project]
2
+ name = "openitinerary"
3
+ version = "0.1.1"
4
+ description = "OpenItinerary is an open, vendor-neutral standard for representing travel itineraries as structured data."
5
+ readme = "README.md"
6
+ license = "Apache-2.0"
7
+ license-files = ["LICENSE"]
8
+ authors = [
9
+ { name = "kiran94" }
10
+ ]
11
+ requires-python = ">=3.11"
12
+ keywords = [ "itinerary", "open", "standard", "travel", "flight", "mcp" ]
13
+ classifiers = [
14
+ "Intended Audience :: Developers",
15
+ "Operating System :: OS Independent",
16
+ "Topic :: Utilities",
17
+ "Topic :: Software Development",
18
+ "Topic :: Software Development :: Version Control :: Git"
19
+ ]
20
+ dependencies = [
21
+ "pycountry>=26.2.16",
22
+ "pydantic[email]>=2.13.4",
23
+ "pydantic-extra-types>=2.11.1",
24
+ "tzdata>=2026.3",
25
+ ]
26
+
27
+
28
+ [project.optional-dependencies]
29
+ adapters = [
30
+ "beautifulsoup4>=4.15.0",
31
+ "fastapi[standard]>=0.141.1",
32
+ "pydantic-ai>=2.22.0",
33
+ "pydantic-ai-slim[duckduckgo]>=2.22.0",
34
+ "pypdf>=6.14.2",
35
+ ]
36
+
37
+ [project.scripts]
38
+ openitinerary = "openitinerary:main"
39
+
40
+ [project.urls]
41
+ Homepage = "https://pypi.org/project/openitinerary/"
42
+ Repository = "https://github.com/kiran94/openitinerary"
43
+ Documentation = "https://github.com/kiran94/openitinerary/blob/main/README.md"
44
+
45
+ [build-system]
46
+ requires = ["uv_build>=0.11.8,<0.12.0"]
47
+ build-backend = "uv_build"
48
+
49
+ [dependency-groups]
50
+ dev = [
51
+ "pytest>=9.0.3",
52
+ "ruff>=0.15.20",
53
+ ]
54
+
55
+ [tool.ruff]
56
+ line-length = 120
@@ -0,0 +1,43 @@
1
+ import argparse
2
+ import json
3
+ import logging
4
+ import os
5
+ from pathlib import Path
6
+
7
+ from openitinerary.models.itinerary import Itinerary
8
+ from openitinerary.version import OPEN_ITINERARY_VERSION, derive_major_minor
9
+
10
+ logging.basicConfig(format=logging.BASIC_FORMAT, level=logging.INFO)
11
+ logger = logging.getLogger(__name__)
12
+
13
+ SCHEMAS_FOLDER = "schemas"
14
+ SCHEMAS_FILE = "itinerary.schema.json"
15
+
16
+
17
+ def main() -> None:
18
+ parser = argparse.ArgumentParser()
19
+ parser.add_argument("-o", "--output", choices=["stdout", "versioned"], default="stdout")
20
+ parser.add_argument("-i", "--indent", action="store_true")
21
+
22
+ args = parser.parse_args()
23
+
24
+ logger.debug("generating schema from Itinerary")
25
+ schema = Itinerary.model_json_schema()
26
+
27
+ indent = 4 if args.indent else None
28
+
29
+ if args.output == "stdout":
30
+ print(json.dumps(schema, indent=indent))
31
+ elif args.output == "versioned":
32
+ major_minor_folder = derive_major_minor(OPEN_ITINERARY_VERSION)
33
+ versioned_folder = Path(os.getcwd()) / SCHEMAS_FOLDER / major_minor_folder
34
+ versioned_file = versioned_folder / SCHEMAS_FILE
35
+
36
+ logger.info("output schema to %s", versioned_file)
37
+
38
+ os.makedirs(versioned_folder, exist_ok=True)
39
+
40
+ with open(versioned_file, "w") as f:
41
+ json.dump(schema, f, indent=indent)
42
+ else:
43
+ raise NotImplementedError({args.output})