Skip to main content

A Python client for importing and exporting SSP (System Structure and Parameterization) models with easySSP.

Project description

easyssp-logo-light

easySSP Import-Export Python Client

This is the official Python client for the Import/Export API of the easySSP. This client simplifies the process of importing and exporting .ssp and .ssd model files through the API, enabling easy programmatic access for integration into your workflows.


✨ Features

  • 📤 Import .ssp and .ssd files into the easySSP platform
  • 🔎 View imported models directly in easySSP
  • 📥 Export .ssp files from easySSP for use in other tools or storage

📦 Installation

pip install easyssp-import-export-client

Or clone and install from source:

git clone https://github.com/exxcellent/easyssp-import-export-client-python.git
cd easyssp-import-export-client-python
pip install -e .

Tests

Execute pytest or python -m pytest to run the tests.

📁 Project Structure

easyssp_import_export/
├── __init__.py
├── client/
│   ├── __init__.py
│   └── import_export_client.py      # Importing and exporting .ssp/.ssd files
│
├── models/
│   ├── __init__.py
│   └── upload_response.py           # Info about the uploaded .ssp/.ssd file

📖 API Reference

This client is built against the official Import/Export API specification, available as an OpenAPI (Swagger) document.

You can explore the full API documentation here:
👉 Import/Export API

📚 Examples Repository & Extended Documentation

Looking for working demos? Check out the Import/Export Client Examples Repository here:
👉 Import/Export Client Examples Repository

It includes:

  • Real-world examples for importing and exporting .ssp/.ssd files
  • Usage patterns for authentication and error handling

It's the best place to explore how the client works in action and how to integrate it into your own workflows.

🛠️ Requirements

  • Python 3.11+
  • easyssp Pro Edition Account

Install dependencies using uv:

pip install uv
uv sync

🤝 Contributing

This module is maintained as part of the easySSP ecosystem. If you find issues or want to suggest improvements, please open an issue or submit a pull request.

📄 License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

easyssp_import_export_client-1.0.0.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

easyssp_import_export_client-1.0.0-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file easyssp_import_export_client-1.0.0.tar.gz.

File metadata

File hashes

Hashes for easyssp_import_export_client-1.0.0.tar.gz
Algorithm Hash digest
SHA256 94a808939185b5388c46009794294b43a0741238b0a2a05d5ad55d2a0e820de9
MD5 3e4c46483318f37310bbb013f1faf9ef
BLAKE2b-256 de4919d4922e716291ee216fe76e04abfcdc184e9de9ec9842777d232d99d943

See more details on using hashes here.

File details

Details for the file easyssp_import_export_client-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for easyssp_import_export_client-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 83d0a96cf06f0c83abb743dcab4b0449f17913bfe3d6c67c1cf7cec4819d9df8
MD5 4e3cca214156f89c78749cb03cf3cccb
BLAKE2b-256 856564eb2d13790d315ebd1bd5c5804dc6779e1b068d26a3bae0c0e2823bf46a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page