Python client for interacting with the necmec API
Project description
NECMEC API python wrapper Client
A Python client for interacting with the NECMEC API python wrapper. This API allows users to submit reports, upload files, and perform other operations necessary to complete the submission process. Base API docs https://exttest.cybertip.org/ispws/documentation/index.html#overview
Features
- Verify Connection: Check if the client can connect to the server and authenticate.
- Download XSD Schema: Retrieve the latest XML Schema Definition (XSD) for report submission.
- Report Submission: Open and submit a report in the system.
- File Upload: Upload files to a report.
- File Details: Provide additional details for uploaded files.
- Finish Submission: Finish the report submission process.
- Retract Submission: Cancel an open report submission.
Installation
To install the package, you can use pip:
pip install .
help
python3 -m necmec_api.cli --help
status
python3 -m necmec_api.cli --config config.json --username your_username --password your_password --environment test status
submit a report
python3 -m necmec_api.cli --config config.json --username your_username --password your_password --environment test submit "<xml_data>"
Cancel the Report
python3 -m necmec_api.cli --config config.json --username your_username --password your_password --environment test retract <report_id>
Refer demo.py
python3 demo.py
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file necmec_api-0.1.2.tar.gz.
File metadata
- Download URL: necmec_api-0.1.2.tar.gz
- Upload date:
- Size: 4.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a7c0b5be2cd94f962b68e209bd6412c3ee86a31d3a5ab8b3e29f8e3aa8269b1b
|
|
| MD5 |
7ebb3afa84a7b1e246b0c4f2673e27b7
|
|
| BLAKE2b-256 |
6258a7660a3433bf5f6c456a443c203327e2708e275fb28d9a8d3133e15ba6ca
|
File details
Details for the file necmec_api-0.1.2-py3-none-any.whl.
File metadata
- Download URL: necmec_api-0.1.2-py3-none-any.whl
- Upload date:
- Size: 5.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bb43a62dff3f8c633533de381ba58e4592a8e6b025b0ff9fff29f30a365cdb29
|
|
| MD5 |
8f86489d9af2b24a370ce8c0f1bab0c8
|
|
| BLAKE2b-256 |
13b3fcfa2bb6f37f516598f0cffdbde673975799ad68f5cd516e3b91e55b68d4
|