├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── README.md ├── poetry.lock ├── pyproject.toml ├── scripts.py ├── tests ├── __init__.py ├── config_template.py └── test_reader.py └── xer_reader ├── __init__.py └── src ├── reader.py ├── table.py └── table_data.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Project specific 2 | *.xer 3 | *.csv 4 | *.xlsx 5 | temp/ 6 | test.py 7 | 8 | # Byte-compiled / optimized / DLL files 9 | __pycache__/ 10 | *.py[cod] 11 | *$py.class 12 | 13 | # C extensions 14 | *.so 15 | 16 | # Distribution / packaging 17 | .Python 18 | build/ 19 | develop-eggs/ 20 | dist/ 21 | downloads/ 22 | eggs/ 23 | .eggs/ 24 | lib/ 25 | lib64/ 26 | parts/ 27 | sdist/ 28 | var/ 29 | wheels/ 30 | pip-wheel-metadata/ 31 | share/python-wheels/ 32 | *.egg-info/ 33 | .installed.cfg 34 | *.egg 35 | MANIFEST 36 | 37 | # PyInstaller 38 | # Usually these files are written by a python script from a template 39 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 40 | *.manifest 41 | *.spec 42 | 43 | # Installer logs 44 | pip-log.txt 45 | pip-delete-this-directory.txt 46 | 47 | # Unit test / coverage reports 48 | htmlcov/ 49 | .tox/ 50 | .nox/ 51 | .coverage 52 | .coverage.* 53 | .cache 54 | nosetests.xml 55 | coverage.xml 56 | *.cover 57 | *.py,cover 58 | .hypothesis/ 59 | .pytest_cache/ 60 | 61 | # Translations 62 | *.mo 63 | *.pot 64 | 65 | # Django stuff: 66 | *.log 67 | local_settings.py 68 | db.sqlite3 69 | db.sqlite3-journal 70 | 71 | # Flask stuff: 72 | instance/ 73 | .webassets-cache 74 | 75 | # Scrapy stuff: 76 | .scrapy 77 | 78 | # Sphinx documentation 79 | docs/_build/ 80 | 81 | # PyBuilder 82 | target/ 83 | 84 | # Jupyter Notebook 85 | .ipynb_checkpoints 86 | 87 | # IPython 88 | profile_default/ 89 | ipython_config.py 90 | 91 | # pyenv 92 | .python-version 93 | 94 | # pipenv 95 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 96 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 97 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 98 | # install all needed dependencies. 99 | #Pipfile.lock 100 | 101 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 102 | __pypackages__/ 103 | 104 | # Celery stuff 105 | celerybeat-schedule 106 | celerybeat.pid 107 | 108 | # SageMath parsed files 109 | *.sage.py 110 | 111 | # Environments 112 | .env 113 | .venv 114 | env/ 115 | venv/ 116 | ENV/ 117 | env.bak/ 118 | venv.bak/ 119 | 120 | # Spyder project settings 121 | .spyderproject 122 | .spyproject 123 | 124 | # Rope project settings 125 | .ropeproject 126 | 127 | # mkdocs documentation 128 | /site 129 | 130 | # mypy 131 | .mypy_cache/ 132 | .dmypy.json 133 | dmypy.json 134 | 135 | # Pyre type checker 136 | .pyre/ 137 | 138 | .vscode/ 139 | tests/fixtures/*.json 140 | tests/config.py 141 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog - xer-reader 2 | 3 | ## 0.4.1 - 2024-12-20 4 | 5 | Corrections to README. 6 | 7 | --- 8 | 9 | ## 0.4.0 - 2024-11-21 10 | 11 | * Reference [Issue #2](https://github.com/jjCode01/xer-reader/issues/2) 12 | * The `to_dict` method no longer throws an error if an unreckognized table is found; it now just ignores the table. 13 | * Added `FINTMPL` to table_data. 14 | * Updated `to_csv` method: 15 | * Can now pass a list of table names to export to CSV. For example pass in agrument `table_names=["TASK", "PROJWBS"]` to only export the task and wbs tables to CSV. 16 | * Can now change the delimeter. For example, pass in argument `delimeter=","` to use a coma rather than the default tab. 17 | 18 | --- 19 | 20 | ## 0.3.2 - 2024-10-05 21 | 22 | Clean up code. 23 | 24 | --- 25 | 26 | ## 0.3.1 - 2024-07-02 27 | 28 | Patched potential errors when transformming from a string to a float. Some languages use a comma rather than a period in floating point numbers. [Issue #1](https://github.com/jjCode01/xer-reader/issues/1) 29 | 30 | --- 31 | 32 | ## 0.2.0 - 2024-02-02 33 | 34 | Added `to_excel` function. Export the tables in the .xer file to individual spreadsheets in a .xlsx file. 35 | 36 | --- 37 | 38 | ## 0.1.5 - 2023-11-22 39 | 40 | * Added docstrings for attributes. 41 | * Fixed typo in README. 42 | 43 | --- 44 | 45 | ## 0.1.4 - 2023-10-12 46 | 47 | Access to `Table` class. 48 | 49 | --- 50 | 51 | ## 0.1.3 - 2023-10-06 52 | 53 | General code clean up. 54 | 55 | --- 56 | 57 | ## 0.1.2 - 2023-10-05 58 | 59 | ### Added 60 | 61 | * Added `currency` attribute pulled from ERMHDR values. 62 | * Added `get_table_names` method. 63 | * Added `has_table` method. 64 | * Added `parse_tables` method. Replaces the `tables` attribute. 65 | 66 | ### Removed 67 | 68 | * Removed `tables` attribute. The tables are now returned in the `parse_tables` method. 69 | 70 | --- 71 | 72 | ## 0.1.1 - 2023-09-30 73 | 74 | Fixed typo in README example. 75 | 76 | --- 77 | 78 | ## 0.1.0 - 2023-09-30 79 | 80 | Initial version. 81 | 82 | --- -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Xer-Reader 2 | 3 | Read the contents of a Primavera P6 XER file using Python. 4 | 5 | Xer-Reader makes it easy to read, parse, and convert the data in a XER file to other formats. 6 | 7 | _Refer to the [Oracle Documentation](https://docs.oracle.com/cd/F25600_01/English/Mapping_and_Schema/xer_import_export_data_map_project/index.htm) for more information regarding how data is mapped to the XER format. 8 | Tested on XER files exported as versions 15.2 through 19.12._ 9 | 10 | ## Install 11 | 12 | **Windows**: 13 | 14 | ```bash 15 | pip install xer-reader 16 | ``` 17 | 18 | **Linux/Mac**: 19 | 20 | ```bash 21 | pip3 install xer-reader 22 | ``` 23 | 24 | ## Usage 25 | 26 | Import the `XerReader` class from `xer_reader`. 27 | 28 | ```python 29 | from xer_reader import XerReader 30 | ``` 31 | 32 | Create a new instance of an `XerReader` object by passing in the XER file as an argument. `XerReader` can accept the file path represented as a `str` or pathlib `Path` object, or a Binary file received as a response from requests, Flask, FastAPI, etc... 33 | 34 | ```python 35 | file = r"/path/to/file.xer" 36 | reader = XerReader(file) 37 | ``` 38 | 39 | ### Attributes 40 | 41 | - `data` [str] - _The contents of the XER file as a string._ 42 | - `export_date` [datetime] - _The date the XER file was exported._ 43 | - `export_user` [str] - _The P6 user who export the XER file._ 44 | - `export_version` [str] - _The P6 verison used to export the XER file._ 45 | - `file_name` [str] - _The name of the file without the '.xer' extension._ 46 | 47 | ### Methods 48 | 49 | **`check_errors()`** -> _list[str]_ 50 | Checks the XER file for missing tables and orphan data, and returns the results as a list of errors. 51 | 52 | - Missing tables can occur when an entry in _Table 1_ points to an entry in _Table 2_ but _Table 2_ does not exist at all. 53 | - Orphan data occurs when an entry in _Table 1_ points to an entry _Table 2_ but the entry in _Table 2_ does not exist. 54 | 55 | **`delete_tables(*table_names: str)`** -> _str_ 56 | Delete a variable number of tables (_table_names_) from the XER file data and returns a new string (_Does not modify `XerReader.data` attribute_). 57 | 58 | In the following example the tables associated with User Defined Fields are removed from the XER file contents and stored in a new variable `new_xer_data`, which can then be written to a new XER file: 59 | 60 | ```python 61 | new_xer_data = reader.delete_tables("UDFTYPE", "UDFVALUE") 62 | 63 | with open("New_XER.xer", "w", encoding=XerReader.CODEC) as new_xer_file: 64 | new_xer_file.write(new_xer_data) 65 | ``` 66 | 67 | **`get_table_names()`** -> _list[str]_ 68 | Returns a list of table names included in the XER file. 69 | 70 | **`get_table_str(table_name: str)`** -> _str_ 71 | Returns the tab seperated text for a specific table in the XER file. 72 | 73 | **`has_table(table_name: str)`** -> _bool_ 74 | Return True if table (`table_name`) if found in the XER file. 75 | 76 | **`to_dict()`** -> _dict[str, Table]_ 77 | Returns a dictionary with the table name as the key and a `Table` object as the value. 78 | 79 | **`to_csv(file_directory: str | Path, table_names: list[str], delimeter: str)`** -> _None_ 80 | Generate a CSV file for each table in the XER file. CSV files will be created in the current working directory. 81 | Optional `file_directory`: Pass a string or Path object to specify a folder to store the CSV files in. 82 | Optional `table_names`: List of tables names to save to CSV files. 83 | Optional `delimeter`: Change the default delimeter from a `tab` to another string (e.g. a coma ","). 84 | 85 | ```python 86 | reader.to_csv(table_names=["TASK", "PROJWBS"], delimeter=",") 87 | ``` 88 | 89 | **`to_excel()`** -> _None_ 90 | Generate an Excel (.xlsx) file with each table in the XER file on its own spreadsheet. The Excel file will be create in the 91 | current working directory. 92 | 93 | **`to_json(*tables: str)`** -> _str_ 94 | Generate a json compliant string representation of the tables in the XER file. 95 | Optional: Pass in specific table names to include in the json string. 96 | -------------------------------------------------------------------------------- /poetry.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Poetry 1.8.4 and should not be changed by hand. 2 | 3 | [[package]] 4 | name = "colorama" 5 | version = "0.4.6" 6 | description = "Cross-platform colored terminal text." 7 | optional = false 8 | python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" 9 | files = [ 10 | {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, 11 | {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, 12 | ] 13 | 14 | [[package]] 15 | name = "et-xmlfile" 16 | version = "2.0.0" 17 | description = "An implementation of lxml.xmlfile for the standard library" 18 | optional = false 19 | python-versions = ">=3.8" 20 | files = [ 21 | {file = "et_xmlfile-2.0.0-py3-none-any.whl", hash = "sha256:7a91720bc756843502c3b7504c77b8fe44217c85c537d85037f0f536151b2caa"}, 22 | {file = "et_xmlfile-2.0.0.tar.gz", hash = "sha256:dab3f4764309081ce75662649be815c4c9081e88f0837825f90fd28317d4da54"}, 23 | ] 24 | 25 | [[package]] 26 | name = "openpyxl" 27 | version = "3.1.5" 28 | description = "A Python library to read/write Excel 2010 xlsx/xlsm files" 29 | optional = false 30 | python-versions = ">=3.8" 31 | files = [ 32 | {file = "openpyxl-3.1.5-py2.py3-none-any.whl", hash = "sha256:5282c12b107bffeef825f4617dc029afaf41d0ea60823bbb665ef3079dc79de2"}, 33 | {file = "openpyxl-3.1.5.tar.gz", hash = "sha256:cf0e3cf56142039133628b5acffe8ef0c12bc902d2aadd3e0fe5878dc08d1050"}, 34 | ] 35 | 36 | [package.dependencies] 37 | et-xmlfile = "*" 38 | 39 | [[package]] 40 | name = "tqdm" 41 | version = "4.67.1" 42 | description = "Fast, Extensible Progress Meter" 43 | optional = false 44 | python-versions = ">=3.7" 45 | files = [ 46 | {file = "tqdm-4.67.1-py3-none-any.whl", hash = "sha256:26445eca388f82e72884e0d580d5464cd801a3ea01e63e5601bdff9ba6a48de2"}, 47 | {file = "tqdm-4.67.1.tar.gz", hash = "sha256:f8aef9c52c08c13a65f30ea34f4e5aac3fd1a34959879d7e59e63027286627f2"}, 48 | ] 49 | 50 | [package.dependencies] 51 | colorama = {version = "*", markers = "platform_system == \"Windows\""} 52 | 53 | [package.extras] 54 | dev = ["nbval", "pytest (>=6)", "pytest-asyncio (>=0.24)", "pytest-cov", "pytest-timeout"] 55 | discord = ["requests"] 56 | notebook = ["ipywidgets (>=6)"] 57 | slack = ["slack-sdk"] 58 | telegram = ["requests"] 59 | 60 | [metadata] 61 | lock-version = "2.0" 62 | python-versions = "^3.10" 63 | content-hash = "2fdce0c4be59f3d614eeee47423cf17fd031b920eb8c1bfe44eee50a49f0bedf" 64 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.poetry] 2 | name = "xer-reader" 3 | version = "0.4.1" 4 | description = "Read and parse a Primavera P6 xer file." 5 | authors = ["Jesse Jones "] 6 | license = "GPL-3.0-only" 7 | readme = "README.md" 8 | keywords = ["primavera", "p6", "xer", "schedule", "scheduling", "planning", "project management", "project controls"] 9 | repository = "https://github.com/jjCode01/xer-reader" 10 | 11 | [tool.poetry.dependencies] 12 | python = "^3.10" 13 | openpyxl = "^3.1.2" 14 | 15 | [tool.poetry.group.test.dependencies] 16 | tqdm = "^4.66.1" 17 | 18 | [tool.poetry.scripts] 19 | test = 'scripts:test' 20 | 21 | [build-system] 22 | requires = ["poetry-core"] 23 | build-backend = "poetry.core.masonry.api" 24 | -------------------------------------------------------------------------------- /scripts.py: -------------------------------------------------------------------------------- 1 | import subprocess 2 | 3 | 4 | def test(): 5 | """ 6 | Run all unittests. Equivalent to: 7 | `poetry run python -u -m unittest discover` 8 | """ 9 | subprocess.run(["python", "-u", "-m", "unittest", "discover"]) -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jjCode01/xer-reader/f9fafd896e5900c702bdfe32c9b5dfdba1fac26c/tests/__init__.py -------------------------------------------------------------------------------- /tests/config_template.py: -------------------------------------------------------------------------------- 1 | """ 2 | !!! COPY THIS FILE TO config.py !!! 3 | 4 | Replace value of `directory` with the path to a folder containing .xer files. 5 | The test setup will recursively run through this folder and any subfolders to find 6 | all .xer files. 7 | 8 | Caution: the more .xer files found, the longer the setup and test will take to run. 9 | 10 | """ 11 | 12 | # Change directory to path containing .xer files 13 | directory = r"path/to/xer/files" -------------------------------------------------------------------------------- /tests/test_reader.py: -------------------------------------------------------------------------------- 1 | """ 2 | Unittests for xer-reader. 3 | 4 | Setup the config.py file - follow instructions in config_template.py 5 | 6 | Each unittest will run through all .xer file in the specified directory, 7 | create an instance of XerReader, and run the assertion tests. 8 | """ 9 | 10 | import re 11 | import unittest 12 | from datetime import datetime 13 | from pathlib import Path 14 | 15 | from tqdm import tqdm 16 | 17 | import tests.config as config 18 | from xer_reader.src.reader import XerReader 19 | 20 | date_format = "%Y-%m-%d" 21 | 22 | 23 | def get_xer_files() -> list: 24 | # Pull location of xer files from config file 25 | xer_file_path = Path(config.directory) 26 | 27 | # Verify location of xer files is valid 28 | if not xer_file_path.exists(): 29 | raise FileNotFoundError(f"Could not find the directory {config.directory}") 30 | 31 | # Get list of xer files 32 | xer_files = [file for file in Path(config.directory).glob("**/*.xer")] 33 | if not xer_files: 34 | raise FileNotFoundError(f"No .xer files found in {xer_file_path.absolute()}") 35 | 36 | return xer_files 37 | 38 | 39 | class TestReader(unittest.TestCase): 40 | def setUp(self) -> None: 41 | self.temp_folder = Path.cwd().joinpath("temp") 42 | self.files = get_xer_files() 43 | 44 | def tearDown(self) -> None: 45 | """Remove temporary files created during the test.""" 46 | if self.temp_folder.is_dir(): 47 | for file in self.temp_folder.glob("*.*"): 48 | Path.unlink(file) 49 | # self.temp_folder.rmdir() 50 | 51 | def test_reader(self): 52 | print(f"Running XER Reader tests on {len(self.files)} .xer files.") 53 | for file in tqdm(self.files): 54 | reader = XerReader(file) 55 | tables = reader.to_dict() 56 | self.assertIsInstance(reader.export_date, datetime) 57 | self.assertRegex(reader.export_version, re.compile(r"\d+\.\d+")) 58 | for name, table in tables.items(): 59 | self.assertGreaterEqual(len(table), 1) 60 | 61 | def test_delete_table(self): 62 | print(f"Running delete_table tests on {len(self.files)} .xer files.") 63 | for file in tqdm(self.files): 64 | reader = XerReader(file) 65 | tables = reader.to_dict() 66 | for table in tables.keys(): 67 | self.assertNotIn("%T\t{table}\n", reader.delete_tables(table)) 68 | 69 | def test_get_table_str(self): 70 | print(f"Running get_table_str tests on {len(self.files)} .xer files.") 71 | for file in tqdm(self.files): 72 | reader = XerReader(file) 73 | self.assertEqual(reader.get_table_str("TEST_TABLE"), "") 74 | self.assertEqual(reader.get_table_str("CALENDAR")[:8], "clndr_id") 75 | self.assertEqual(reader.get_table_str("PROJECT")[:7], "proj_id") 76 | self.assertEqual(reader.get_table_str("PROJWBS")[:6], "wbs_id") 77 | 78 | def test_to_csv(self): 79 | print(f"Running to_csv tests on {len(self.files)} .xer files.") 80 | for file in tqdm(self.files): 81 | reader = XerReader(file) 82 | tables = reader.to_dict() 83 | temp_folder = Path.cwd().joinpath("temp") 84 | if not temp_folder.is_dir(): 85 | Path.mkdir(temp_folder) 86 | 87 | reader.to_csv(temp_folder) 88 | 89 | for table_name in tables.keys(): 90 | csv_file = temp_folder.joinpath(f"{reader.file_name}_{table_name}.csv") 91 | self.assertTrue( 92 | csv_file.is_file(), 93 | f"{table_name}.csv", 94 | ) 95 | if csv_file.is_file(): 96 | Path.unlink(csv_file) 97 | 98 | # def test_to_excel(self): 99 | # print(f"Running to_excel tests on {len(self.files)} .xer files.") 100 | # for file in tqdm(self.files): 101 | # reader = XerReader(file) 102 | # temp_folder = Path.cwd().joinpath("temp") 103 | # if not temp_folder.is_dir(): 104 | # Path.mkdir(temp_folder) 105 | 106 | # reader.to_excel(temp_folder) 107 | 108 | # excel_file = temp_folder.joinpath(f"{reader.file_name}.xlsx") 109 | # self.assertTrue( 110 | # excel_file.is_file(), 111 | # f"{reader.file_name}.xlsx", 112 | # ) 113 | # if excel_file.is_file(): 114 | # Path.unlink(excel_file) 115 | -------------------------------------------------------------------------------- /xer_reader/__init__.py: -------------------------------------------------------------------------------- 1 | __version__ = "0.4.0" 2 | 3 | from xer_reader.src.reader import XerReader # noqa: F401 4 | from xer_reader.src.table import XerTable # noqa: F401 5 | -------------------------------------------------------------------------------- /xer_reader/src/reader.py: -------------------------------------------------------------------------------- 1 | """ 2 | This module contains the `XerReader class, which represents the contents of 3 | an XER file exported from Primavera P6. 4 | 5 | """ 6 | 7 | import csv 8 | import json 9 | import re 10 | from datetime import datetime 11 | from pathlib import Path 12 | from typing import BinaryIO 13 | 14 | from openpyxl import Workbook 15 | from openpyxl.worksheet.table import Table 16 | 17 | from xer_reader.src.table import XerTable, UnrecognizedTable 18 | from xer_reader.src.table_data import table_data 19 | 20 | DATE_FORMAT = "%Y-%m-%d" 21 | REQUIRED_TABLES = {"CALENDAR", "CURRTYPE", "PROJECT", "PROJWBS"} 22 | 23 | 24 | class XerReader: 25 | """Open an XER file exported from Primavera P6 and read its contents.""" 26 | 27 | CODEC = "cp1252" 28 | file_name: str 29 | """XER file name""" 30 | data: str 31 | """XER file raw data as tab seperated text""" 32 | 33 | def __init__(self, file: str | Path | BinaryIO) -> None: 34 | self.file_name, self.data = _read_file(file) 35 | 36 | _file_info = _parse_file_info(self.data) 37 | self.currency: str = _file_info[7] 38 | """(str) Currency type set in P6""" 39 | self.export_version: str = _file_info[0] 40 | """(str) P6 Version""" 41 | self.export_date: datetime = datetime.strptime(_file_info[1], DATE_FORMAT) 42 | """(datetime) Date the XER file was exported""" 43 | self.export_user: str = _file_info[4] 44 | """(str) P6 user name that exported the XER file""" 45 | 46 | def check_errors(self) -> list[str]: 47 | """Check XER file for missing tables and orphan data 48 | 49 | Returns: 50 | list[str]: Descriptions of missing information 51 | """ 52 | errors = set() 53 | 54 | id_map = { 55 | data["key"]: table for table, data in table_data.items() if data["key"] 56 | } 57 | 58 | tables = self.to_dict() 59 | 60 | # Check for minimum tables required to be in the XER 61 | for name in REQUIRED_TABLES: 62 | if name not in tables: 63 | errors.add(f"Missing Required Table {name}") 64 | 65 | # Check for required table pairs 66 | for table in tables.values(): 67 | for table2 in table.depends: 68 | if table2 not in tables: 69 | errors.add(f"Missing Table {table2} Required for Table {table}") 70 | 71 | for row in table.entries(): 72 | for key, val in row.items(): 73 | if val == "": 74 | continue 75 | if not key.endswith("_id"): 76 | continue 77 | if key == "parent_wbs_id" and row["proj_node_flag"] == "Y": 78 | continue 79 | clean_key = key if key in id_map else _clean_foreign_key_label(key) 80 | if clean_key: 81 | if check_table := tables.get(id_map[clean_key]): 82 | for entry in check_table.entries(): 83 | if entry.get(clean_key, "") == val: 84 | break 85 | else: 86 | errors.add( 87 | f"Orphan data {key} [{val}] in table {table}" 88 | ) 89 | 90 | return list(errors) 91 | 92 | def delete_tables(self, *table_names: str) -> str: 93 | """ 94 | Delete tables from XER file. 95 | Does not modify `XerReader.data` attribute, but returns a new string. 96 | 97 | Args: 98 | *table_names (str): table names to remove from XER file 99 | 100 | Returns: 101 | str: XER File String with tables removed 102 | """ 103 | if not table_names: 104 | raise ValueError("Must pass at least one table name") 105 | 106 | rev_data = self.data 107 | for name in table_names: 108 | table_search = re.compile(rf"%T\t{name.upper()}\r?\n(.|\s)*?(?=%T|%E)") 109 | rev_data = table_search.sub("", rev_data) 110 | return rev_data 111 | 112 | def get_table_names(self) -> list[str]: 113 | """Get list of table names included in the XER file. 114 | 115 | Returns: 116 | list[str]: list of table names 117 | """ 118 | table_names = re.compile(r"(?<=%T\t)[A-Z]+") 119 | return table_names.findall(self.data) 120 | 121 | def get_table_str(self, table_name: str) -> str: 122 | """Get string for a specific table in the XER file. 123 | 124 | Args: 125 | table_name (str): Name of table 126 | 127 | Returns: 128 | str: Table header and rows 129 | """ 130 | re_search = re.compile(rf"(?<=%T\t{table_name.upper()}\n)(.|\s)*?(?=%T|%E)") 131 | if found_table := re_search.search(self.data): 132 | return re.sub(r"%[TFR]\t", "", found_table.group()) 133 | return "" 134 | 135 | def has_table(self, table_name: str) -> bool: 136 | """Check if a table is included in the XER file. 137 | 138 | Args: 139 | table_name (str): table name 140 | 141 | Returns: 142 | bool: True if found; False if not found 143 | """ 144 | return f"%T\t{table_name.upper()}" in self.data 145 | 146 | def to_dict(self) -> dict[str, XerTable]: 147 | """ 148 | Parse tables into a dictionary with the table name as the key 149 | and a `Table` object as the value. 150 | 151 | Returns: 152 | dict[str, Table]: dict of XER Tables 153 | """ 154 | tables = {} 155 | for table_str in self.data.split("%T\t")[1:]: 156 | try: 157 | table = XerTable(table_str) 158 | tables[table.name] = table 159 | except UnrecognizedTable: 160 | continue 161 | return tables 162 | 163 | def to_csv( 164 | self, 165 | file_directory: str | Path = Path.cwd(), 166 | table_names: list[str] = [], 167 | delimeter: str = "\t", 168 | ) -> None: 169 | """ 170 | Generate a CSV file for each table in the XER file. 171 | Uses `tab` as the delimiter by default. 172 | 173 | Args: 174 | file_directory (str | Path, optional): Directory to save CSV files. [Defaults to current working directory] 175 | table_names (list, optional): List of table names to save to CSV files. If empty, all tables will be saved. 176 | delimeter (str, optional): CSV delimeter. [Default is a `tab`] 177 | """ 178 | names = [name.upper() for name in table_names] 179 | for table in self.to_dict().values(): 180 | if not table_names or table.name in names: 181 | _write_table_to_csv( 182 | f"{self.file_name}_{table.name}", 183 | table, 184 | Path(file_directory), 185 | delimeter, 186 | ) 187 | 188 | def to_excel(self, file_directory: str | Path = Path.cwd()) -> None: 189 | """ 190 | Generate an Excel file with each table in the XER file on a seperate worksheet. 191 | 192 | """ 193 | wb = Workbook() 194 | ws = wb.active 195 | ws.title = "ERMHDR" 196 | ws.append(_parse_file_info(self.data)) 197 | 198 | for name, table in self.to_dict().items(): 199 | new_ws = wb.create_sheet(name) 200 | new_ws.append(table.labels) 201 | for entry in table.rows: 202 | new_ws.append(entry) 203 | 204 | tab = Table(displayName=name, ref=new_ws.calculate_dimension()) 205 | 206 | new_ws.add_table(tab) 207 | 208 | wb.save(Path(file_directory, f"{self.file_name}.xlsx")) 209 | 210 | def to_json(self, *tables: str) -> str: 211 | """Generate a json compliant string representation of tables in the XER file 212 | 213 | Returns: 214 | str: json compliant string representation of XER tables 215 | """ 216 | out_data = {} 217 | if not tables: 218 | out_data = { 219 | name: _entry_by_key(table) for name, table in self.to_dict().items() 220 | } 221 | else: 222 | out_data = { 223 | name: _entry_by_key(table) 224 | for name, table in self.to_dict().items() 225 | if name in tables 226 | } 227 | json_data = {self.file_name: {**out_data}} 228 | return json.dumps(json_data, indent=2) 229 | 230 | 231 | def _clean_foreign_key_label(label: str) -> str | None: 232 | prefixes = ("base_", "last_", "new_", "parent_", "pred_") 233 | for prefix in prefixes: 234 | if label.startswith(prefix): 235 | return label.replace(prefix, "") 236 | return 237 | 238 | 239 | def _entry_by_key(table: XerTable) -> dict | list: 240 | if not table.key: 241 | return table.entries(serialize=True) 242 | return {entry[table.key]: entry for entry in table.entries(serialize=True)} 243 | 244 | 245 | def _parse_file_info(data: str) -> list[str]: 246 | """Parse file header""" 247 | ermhdr = re.search(r"(?<=ERMHDR\t).+", data) 248 | if not ermhdr: 249 | raise ValueError("Invalid XER File") 250 | return ermhdr.group().split("\t") 251 | 252 | 253 | def _read_file(file: str | Path | BinaryIO) -> tuple[str, str]: 254 | file_contents = "" 255 | file_name = "" 256 | if isinstance(file, (str, Path)): 257 | # Path directory to file 258 | file_name = Path(file).stem 259 | with open(file, encoding=XerReader.CODEC, errors="ignore") as f: 260 | file_contents = f.read() 261 | else: 262 | # Binary file from requests, Flask, FastAPI, etc... 263 | file_contents = file.read().decode(XerReader.CODEC, errors="ignore") 264 | file_name = file.name 265 | 266 | if not file_contents.startswith("ERMHDR"): 267 | raise ValueError(f"ValueError: {file_name} is invalid XER file") 268 | 269 | return file_name, file_contents 270 | 271 | 272 | def _write_table_to_csv( 273 | name: str, table: XerTable, file_directory: Path, delimeter 274 | ) -> None: 275 | with file_directory.joinpath(f"{name}.csv").open("w") as f: 276 | writer = csv.writer(f, delimiter=delimeter) 277 | writer.writerow(table.labels) 278 | for row in table.rows: 279 | writer.writerow(row) 280 | f.close() 281 | -------------------------------------------------------------------------------- /xer_reader/src/table.py: -------------------------------------------------------------------------------- 1 | import re 2 | from datetime import datetime 3 | from typing import Any 4 | 5 | from xer_reader.src.table_data import table_data 6 | 7 | DATE_HR_FORMAT = "%Y-%m-%d %H:%M" 8 | 9 | 10 | class UnrecognizedTable(Exception): 11 | def __init__(self, table: str) -> None: 12 | self.table = table 13 | self.message = f"Unrecognized Table: {self.table}" 14 | 15 | def __str__(self) -> str: 16 | return self.message 17 | 18 | 19 | class XerTable: 20 | """A class representing a P6 table""" 21 | 22 | def __init__(self, data: str) -> None: 23 | _lines: list[str] = re.split(r"\r?\n", data) 24 | 25 | # First line is the table name 26 | self.name: str = _lines.pop(0) 27 | """Table Name""" 28 | 29 | if self.name not in table_data: 30 | raise UnrecognizedTable(self.name) 31 | 32 | self.depends: list[str] = table_data[self.name]["depends"] 33 | """List of Required Foreign Tables""" 34 | self.description: str = table_data[self.name]["description"] 35 | """Discription of Data Contained in Table""" 36 | self.key: str | None = table_data[self.name]["key"] 37 | """Label Name for Unique ID of Table Entries""" 38 | 39 | # Second line is the column labels 40 | self.labels: list[str] = _lines.pop(0).strip().split("\t")[1:] 41 | """List Entry Labels or Column Headers""" 42 | 43 | # Remaining lines are the data rows 44 | self.rows: list[list[str]] = [ 45 | row.split("\t")[1:] for row in _lines if row.startswith("%R") 46 | ] 47 | """Nested Array containing Rows of Data""" 48 | 49 | self._entries: list[dict[str, Any]] = [] 50 | self._serialized: bool = False 51 | 52 | def __bool___(self) -> bool: 53 | return len(self.rows) > 0 54 | 55 | def __getitem__(self, _key): 56 | if isinstance(_key, (int, slice)): 57 | return self.rows[_key] 58 | 59 | if isinstance(_key, str): 60 | if _key not in self.labels: 61 | raise KeyError(f"{_key} not found") 62 | 63 | return [row[_key] for row in self.entries()] 64 | 65 | if isinstance(_key, (list, tuple, set)): 66 | for k in _key: 67 | if k not in self.labels: 68 | raise KeyError("{k} not found") 69 | 70 | return [{k: row[k] for k in _key} for row in self.entries()] 71 | 72 | def __len__(self) -> int: 73 | return len(self.rows) 74 | 75 | def __str__(self) -> str: 76 | return self.name 77 | 78 | def entries(self, serialize: bool = False) -> list[dict[str, str]]: 79 | if not self._entries or serialize != self._serialized: 80 | self._entries = [ 81 | _converter(serialize, **dict(zip(self.labels, row))) 82 | for row in self.rows 83 | ] 84 | self._serialized = serialize 85 | return self._entries 86 | 87 | 88 | def _converter( 89 | serialize: bool, **kwargs: str 90 | ) -> dict[str, None | int | float | datetime | bool]: 91 | return { 92 | label: _convert_entry_data_type(label, value, serialize) 93 | for label, value in kwargs.items() 94 | } 95 | 96 | 97 | def _is_date_label(label: str) -> bool: 98 | return label.endswith(("_date", "_date2")) 99 | 100 | 101 | def _is_float_label(label: str) -> bool: 102 | return label.endswith( 103 | ("_cost", "_hr", "_pct", "_qty", "_qty2", "_qty3", "_qty4", "_qty5", "_rate") 104 | ) 105 | 106 | 107 | def _is_int_label(label: str) -> bool: 108 | return label.endswith( 109 | ("_id", "_base", "_cnt", "_len", "_num", "_order", "_path", "_step") 110 | ) 111 | 112 | 113 | def _convert_entry_data_type( 114 | label: str, value: str, serialize: bool 115 | ) -> None | int | float | datetime | bool: 116 | if value == "": 117 | return None 118 | if _is_int_label(label): 119 | try: 120 | return int(value) 121 | except ValueError: 122 | return value 123 | if _is_float_label(label): 124 | try: 125 | return float(value.replace(",", ".")) 126 | except ValueError: 127 | return value 128 | if not serialize and _is_date_label(label): 129 | return datetime.strptime(value, DATE_HR_FORMAT) 130 | if label.endswith("_flag"): 131 | return value == "Y" 132 | 133 | return value 134 | -------------------------------------------------------------------------------- /xer_reader/src/table_data.py: -------------------------------------------------------------------------------- 1 | table_data = { 2 | "ACCOUNT": { 3 | "key": "acct_id", 4 | "description": "Cost Accounts", 5 | "depends": [], 6 | }, 7 | "ACTVCODE": { 8 | "key": "actv_code_id", 9 | "description": "Activity Code Values", 10 | "depends": ["ACTVTYPE"], 11 | }, 12 | "ACTVTYPE": { 13 | "key": "actv_code_type_id", 14 | "description": "Activity Codes", 15 | "depends": [], 16 | }, 17 | "APPLYACTOPTIONS": { 18 | "key": None, 19 | "description": "Apply Actual Options", 20 | "depends": [], 21 | }, 22 | "ASGNMNTACAT": { 23 | "key": None, 24 | "description": "Assignment Code Assignments", 25 | "depends": ["ASGNMNTCATTYPE", "ASGNMNTCATVAL", "TASKRSRC"], 26 | }, 27 | "ASGNMNTCATTYPE": { 28 | "key": "asgnmnt_catg_type_id", 29 | "description": "Assignment Codes", 30 | "depends": [], 31 | }, 32 | "ASGNMNTCATVAL": { 33 | "key": "asgnmnt_catg_id", 34 | "description": "Assignment Code Values", 35 | "depends": ["ASGNMNTCATTYPE"], 36 | }, 37 | "BUDGCHNG": { 38 | "key": "budg_chng_id", 39 | "description": "Budget Changes", 40 | "depends": [], 41 | }, 42 | "CALENDAR": { 43 | "key": "clndr_id", 44 | "description": "Calendars", 45 | "depends": [], 46 | }, 47 | "COSTTYPE": { 48 | "key": "cost_type_id", 49 | "description": "Expense Categories", 50 | "depends": [], 51 | }, 52 | "CURRTYPE": { 53 | "key": "curr_id", 54 | "description": "Currency Types", 55 | "depends": [], 56 | }, 57 | "DOCCATG": { 58 | "key": "doc_catg_id", 59 | "description": "Document Categories", 60 | "depends": [], 61 | }, 62 | "DOCSTAT": { 63 | "key": "doc_status_id", 64 | "description": "Document Statuses", 65 | "depends": [], 66 | }, 67 | "DOCUMENT": { 68 | "key": "doc_id", 69 | "description": "Work Products and Documents", 70 | "depends": [], 71 | }, 72 | "FINDATES": { 73 | "key": "fin_dates_id", 74 | "description": "Financial Periods", 75 | "depends": [], 76 | }, 77 | "FINTMPL": { 78 | "key": "fintmpl_id", 79 | "description": "Financial Period Calendar", 80 | "depends": [], 81 | }, 82 | "FUNDSRC": { 83 | "key": "fund_id", 84 | "description": "Funding Sources", 85 | "depends": [], 86 | }, 87 | "ISSUHIST": { 88 | "key": None, 89 | "description": "Notification History", 90 | "depends": [], 91 | }, 92 | "MEMOTYPE": { 93 | "key": "memo_type_id", 94 | "description": "Notebook Topics", 95 | "depends": [], 96 | }, 97 | "NONWORK": { 98 | "key": "nonwork_type_id", 99 | "description": "Non-work Types", 100 | "depends": [], 101 | }, 102 | "OBS": { 103 | "key": "obs_id", 104 | "description": "Organization Breakdown Structure", 105 | "depends": [], 106 | }, 107 | "PCATTYPE": { 108 | "key": "proj_catg_type_id", 109 | "description": "Project Codes", 110 | "depends": [], 111 | }, 112 | "PCATVAL": { 113 | "key": "proj_catg_id", 114 | "description": "Project Code Values", 115 | "depends": ["PCATTYPE"], 116 | }, 117 | "PHASE": { 118 | "key": "phase_id", 119 | "description": "Phase Project Code", 120 | "depends": [], 121 | }, 122 | "POBS": { 123 | "key": "pobs_id", 124 | "description": "Extra Data", 125 | "depends": [], 126 | }, 127 | "PROJCOST": { 128 | "key": "cost_item_id", 129 | "description": "Project Expenses", 130 | "depends": ["TASK"], 131 | }, 132 | "PROJECT": { 133 | "key": "proj_id", 134 | "description": "Projects", 135 | "depends": [], 136 | }, 137 | "PROJEST": { 138 | "key": "proj_est_id", 139 | "description": "Estimate History", 140 | "depends": [], 141 | }, 142 | "PROJFUND": { 143 | "key": "proj_fund_id", 144 | "description": "Project Funding Assignments", 145 | "depends": ["FUNDSRC"], 146 | }, 147 | "PROJISSU": { 148 | "key": "issue_id", 149 | "description": "Issues", 150 | "depends": [], 151 | }, 152 | "PROJPCAT": { 153 | "key": None, 154 | "description": "Project Code Assignments", 155 | "depends": ["PCATVAL", "PCATTYPE"], 156 | }, 157 | "PROJTHRS": { 158 | "key": "thresh_id", 159 | "description": "Thresholds", 160 | "depends": [], 161 | }, 162 | "PROJWBS": { 163 | "key": "wbs_id", 164 | "description": "Work Breakdown Structure", 165 | "depends": [], 166 | }, 167 | "PRORISK": { 168 | "key": "risk_id", 169 | "description": "Risks", 170 | "depends": ["RISKTYPE"], 171 | }, 172 | "RCATTYPE": { 173 | "key": "rsrc_catg_type_id", 174 | "description": "Resource Codes", 175 | "depends": [], 176 | }, 177 | "RCATVAL": { 178 | "key": "rsrc_catg_id", 179 | "description": "Resource Code Values", 180 | "depends": ["RCATTYPE"], 181 | }, 182 | "RISKTYPE": { 183 | "key": "risk_type_id", 184 | "description": "Risk Types", 185 | "depends": [], 186 | }, 187 | "ROLECATTYPE": { 188 | "key": "role_catg_type_id", 189 | "description": "Role Codes", 190 | "depends": [], 191 | }, 192 | "ROLECATVAL": { 193 | "key": "role_catg_id", 194 | "description": "Role Code Values", 195 | "depends": ["ROLECATTYPE"], 196 | }, 197 | "ROLELIMIT": { 198 | "key": "rolelimit_id", 199 | "description": "Role Limits", 200 | "depends": ["ROLES"], 201 | }, 202 | "ROLERATE": { 203 | "key": "role_rate_id", 204 | "description": "Role Prices", 205 | "depends": ["ROLES"], 206 | }, 207 | "ROLERCAT": { 208 | "key": None, 209 | "description": "Role Code Assignments", 210 | "depends": ["ROLES", "ROLECATTYPE", "ROLECATVAL"], 211 | }, 212 | "ROLES": { 213 | "key": "role_id", 214 | "description": "Roles", 215 | "depends": [], 216 | }, 217 | "RSRC": { 218 | "key": "rsrc_id", 219 | "description": "Resources", 220 | "depends": [], 221 | }, 222 | "RSRCCURV": { 223 | "key": "curv_id", 224 | "description": "Resource Curves", 225 | "depends": [], 226 | }, 227 | "RSRCCURVDATA": { 228 | "key": None, 229 | "description": "Resource Curve Data", 230 | "depends": ["RSRCCURV"], 231 | }, 232 | "RSRCLEVELLIST": { 233 | "key": "rsrc_level_list_id", 234 | "description": "Resource Level List", 235 | "depends": ["RSRC"], 236 | }, 237 | "RSRCRATE": { 238 | "key": "rsrc_rate_id", 239 | "description": "Resource Prices", 240 | "depends": ["RSRC"], 241 | }, 242 | "RSRCRCAT": { 243 | "key": None, 244 | "description": "Resource Code Assignments", 245 | "depends": ["RCATVAL", "RCATTYPE", "RSRC"], 246 | }, 247 | "RSRCROLE": { 248 | "key": None, 249 | "description": "Resource Role Assignments", 250 | "depends": ["ROLES", "RSRC"], 251 | }, 252 | "SCHEDOPTIONS": { 253 | "key": "schedoptions_id", 254 | "description": "Schedule Options", 255 | "depends": [], 256 | }, 257 | "SHIFT": { 258 | "key": "shift_id", 259 | "description": "Shift Names", 260 | "depends": [], 261 | }, 262 | "SHIFTPER": { 263 | "key": "shift_period_id", 264 | "description": "Shifts", 265 | "depends": ["SHIFT"], 266 | }, 267 | "TASK": { 268 | "key": "task_id", 269 | "description": "Activities", 270 | "depends": ["CALENDAR"], 271 | }, 272 | "TASKACTV": { 273 | "key": None, 274 | "description": "Activity Code Assignments", 275 | "depends": ["ACTVCODE", "TASK"], 276 | }, 277 | "TASKDOC": { 278 | "key": "taskdoc_id", 279 | "description": "Document Assignments", 280 | "depends": ["DOCUMENT", "TASK"], 281 | }, 282 | "TASKFDBK": { 283 | "key": None, 284 | "description": "Activity Feedback", 285 | "depends": ["TASK"], 286 | }, 287 | "TASKFIN": { 288 | "key": None, 289 | "description": "Activity Past Period Actuals", 290 | "depends": ["FINDATES", "TASK"], 291 | }, 292 | "TASKMEMO": { 293 | "key": "memo_id", 294 | "description": "Activity Notebook", 295 | "depends": ["MEMOTYPE", "TASK"], 296 | }, 297 | "TASKNOTE": { 298 | "key": None, 299 | "description": "Activity Notes to Resources", 300 | "depends": ["TASK"], 301 | }, 302 | "TASKPRED": { 303 | "key": "task_pred_id", 304 | "description": "Activity Relationships", 305 | "depends": ["TASK"], 306 | }, 307 | "TASKPROC": { 308 | "key": "proc_id", 309 | "description": "Activity Steps", 310 | "depends": ["TASK"], 311 | }, 312 | "TASKRSRC": { 313 | "key": "taskrsrc_id", 314 | "description": "Activity Resource Assignments", 315 | "depends": ["RSRC", "TASK"], 316 | }, 317 | "TASKUSER": { 318 | "key": None, 319 | "description": "Activity Owners", 320 | "depends": ["TASK"], 321 | }, 322 | "THRSPARM": { 323 | "key": "thresh_parm_id", 324 | "description": "Threshold Parameters", 325 | "depends": [], 326 | }, 327 | "TRSRCFIN": { 328 | "key": None, 329 | "description": "Activity Resource Assignment Past Period Actuals", 330 | "depends": ["FINDATES", "TASKRSRC"], 331 | }, 332 | "UDFTYPE": { 333 | "key": "udf_type_id", 334 | "description": "User Defined Fields", 335 | "depends": [], 336 | }, 337 | "UDFVALUE": { 338 | "key": None, 339 | "description": "User Defined Field Values", 340 | "depends": ["UDFTYPE"], 341 | }, 342 | "UMEASURE": { 343 | "key": "unit_id", 344 | "description": "Units of Measure", 345 | "depends": [], 346 | }, 347 | "WBSBUDG": { 348 | "key": "wbs_budg_id", 349 | "description": "Spending and Benefit Plans", 350 | "depends": [], 351 | }, 352 | "WBSMEMO": { 353 | "key": "wbs_memo_id", 354 | "description": "EPS, Project and WBS Notebook", 355 | "depends": ["MEMOTYPE", "PROJWBS"], 356 | }, 357 | "WBSSTEP": { 358 | "key": "wbs_step_id", 359 | "description": "WBS Milestones", 360 | "depends": [], 361 | }, 362 | } 363 | --------------------------------------------------------------------------------