PyPI 官网下载 | wqxlib-3.0.0.6.0.tar.gz

# Python library for WQX (wqxlib) This is a Python library for creating XML documents for direct submission to WQX Web without using an import configuration file. If your use-case is complex, this feature may save you the hassle of uploading incremental changes to an import configuration file as you detect more edge cases or struggle to make an import configuration file which is flexible enough for your purposes. Just modify your code to produce the proper XML file and use the `WQXWeb` class from the sister project [`wqxweblib`](https://github.com/FlippingBinary/wqxweblib-python) to upload it. It's also useful for submitting new monitoring locations or other types of data which are one-off situations. Sometimes it's easier to just build the XML file directly than it is to first create an import configuration file (or copy one) and specify the parameters in a CSV or XSL file. If you find a bug, please submit a pull request on [Github](https://github.com/FlippingBinary/wqxlib-python) or open an issue there. I'm also open to suggestions for how to improve the creation of XML files. Currently, it's quite complex due to its flexibility. This code is supported by the National Science Foundation under Award No. OIA-1458952. Any opinions, findings and conclusions, or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation. ## Contents - [Python library for WQX (wqxlib)](#python-library-for-wqx-wqxlib) - [Contents](#contents) - [Getting Started](#getting-started) - [Package Versioning](#package-versioning) - [Import WQX Module](#import-wqx-module) - [WQXLib XML API Reference](#wqxlib-xml-api-reference) - [Document](#document) - [Header](#header) - [Payload](#payload) - [Submission](#submission) - [WQXLib's WQX v3.0 XML API Reference](#wqxlibs-wqx-v30-xml-api-reference) - [Activity](#activity) - [ActivityDescription](#activitydescription) - [ActivityGroup](#activitygroup) - [ActivityLocation](#activitylocation) - [ActivityMetric](#activitymetric) - [ActivityMetricType](#activitymetrictype) - [AlternateMonitoringLocationIdentity](#alternatemonitoringlocationidentity) - [AquiferInformation](#aquiferinformation) - [AttachedBinaryObject](#attachedbinaryobject) - [BibliographicReference](#bibliographicreference) - [BiologicalActivityDescription](#biologicalactivitydescription) - [BiologicalHabitatCollectionInformation](#biologicalhabitatcollectioninformation) - [BiologicalHabitatIndex](#biologicalhabitatindex) - [BiologicalResultDescription](#biologicalresultdescription) - [CollectionEffort](#collectioneffort) - [ComparableAnalyticalMethod](#comparableanalyticalmethod) - [DataQualityIndicator](#dataqualityindicator) - [DetectionQuantitationLimit](#detectionquantitationlimit) - [ElectronicAddress](#electronicaddress) - [Entity_Update_Identifiers](#entity_update_identifiers) - [FrequencyClassInformation](#frequencyclassinformation) - [HorizontalAccuracyMeasure](#horizontalaccuracymeasure) - [IndexType](#indextype) - [LabSamplePreparation](#labsamplepreparation) - [Measure](#measure) - [MeasureCompact](#measurecompact) - [MonitoringLocation](#monitoringlocation) - [MonitoringLocationGeospatial](#monitoringlocationgeospatial) - [MonitoringLocationIdentity](#monitoringlocationidentity) - [NetInformation](#netinformation) - [Organization](#organization) - [OrganizationAddress](#organizationaddress) - [OrganizationDescription](#organizationdescription) - [Organization_Delete](#organization_delete) - [Project](#project) - [ProjectMonitoringLocationWeighting](#projectmonitoringlocationweighting) - [ReferenceMethod](#referencemethod) - [Result](#result) - [ResultAnalyticalMethod](#resultanalyticalmethod) - [ResultDescription](#resultdescription) - [ResultLabInformation](#resultlabinformation) - [SampleDescription](#sampledescription) - [SamplePreparation](#samplepreparation) - [SimpleContent](#simplecontent) - [TaxonomicDetails](#taxonomicdetails) - [Telephonic](#telephonic) - [WellInformation](#wellinformation) - [WQX](#wqx) - [WQXTime](#wqxtime) - [WQXDelete](#wqxdelete) - [WQXUpdateIdentifiers](#wqxupdateidentifiers) ## Getting Started Look in the `examples` directory for a more complete example with sample data. 1. Install this package using `pip` pip install wqxlib 2. Import the `WQXSubmission` class from wqxlib import WQXSubmission 3. Use the `with ... as` syntax to create the submission with WQXSubmission(filename='example.xml') as submission: # Manipulate submission object properties 4. After creating the submission, submit it using the `wqxweblib` package or manually in WQX Web. ## Package Versioning This package uses a five-segment version number. The first two segments of the version number indicate the version of WQX it supports. The last three segments follow the [Semantic Versioning](https://semver.org/) standard and are specific to only this package, not any WQX release. They are in the format `x.y.z` where `x` is the major version number, `y` is the minor version number, and `z` is the patch version number. The major version number increments when incompatible API changes are made. The minor version number increments when functionality is added in a backward compatible manner. The patch version number increments when there are backward compatible bug fixes. It is a good practice to lock the first three digits of the version in your `requirements.txt` file, if you are using one. That allow you to safely rebuild your environment without accidentally introducing breaking changes. For the current version, that would mean adding a line to your `requirements.txt` file like this: wqxlib<3.0.1 # WQXLib XML API Reference The following low-level classes describe the larger structure of a valid XML document for WQXWeb submission. These classes contain the building blocks provided by WQX v3.0. You are not required to interact with these directly. Use of the `with ... as` syntax is highly recommended. ## Document The base document type used for submission to WQXWeb. **Parameters:** - `id` (ID) - `header` (Header) - `payload` (List[Payload]) ## Header **Parameters:** - `author` (str) - `organization` (str) - `title` (str) - `creationTime` (datetime) - `comment` (str) - `dataService` (str) - `contactInfo` (str) - `notification` (List[str]) - `sensitivity` (str) - `property` (dict) ## Payload The Payload section of the document contains the WQX data. - `operation` (OperationType) - either "UPDATE_INSERT" or "DELETE". - `wqx` (WQX) - this must be a v3.0 `WQX` object as described in the next section, if provided. - `wqxUpdateIdentifiers` (WQXUpdateIdentifiers) - this must be a v3.0 `WQXUpdateIdentifiers` object as described in the next section, if provided. - `wqxDelete` (WQXDelete) - this must be a v3.0 `WQXDelete` object as described in the next section, if provided. ## Submission This is the container of the entire submission. **Parameters:** - `document` (Document) # WQXLib's WQX v3.0 XML API Reference The following classes describe the building blocks of a v3.0 XML document for WQXWeb submission. This is the current version of the standard and there are no plans to create an API for the older versions. If you want to, please use the pattern of the v3.0 code and submit a pull request so others can benefit from your code too. All of the described classes come directly from the XSD files which are used by WQX to validate input. To import any of the following types, pull them from `wqxlib` like this: from wqxlib import ( MonitoringLocation, MonitoringLocationGeospatial, MonitoringLocationIdentity, Organization