Skip to main content

Easy creation of engineering information models and related specification documents

Project description

DEXPI Specificator

dexpi.specificator is a Python library and CLI tool that lets you generate DEXPI specifications in Python.
It can be installed via PyPI or TestPyPI and used either as a library or a command-line tool to convert specification inputs into specification outputs.


Features

  • Parse input specification files in the DEXPI format
  • Generate DEXPI outputs (XML, JSON, etc.) from those inputs
  • Validate specifications against DEXPI schemas
  • Tested with automated unit tests to ensure correctness
  • Published on PyPI/TestPyPI for easy installation via pip

Installation

Install the stable release from PyPI:

pip install dexpi.specificator

Install the latest development version from TestPyPI:

pip install --index-url https://test.pypi.org/simple/ dexpi.specificator

Usage

Used in Specification Projects

The Specificator is used to generate the DEXPI Specification in CI/CD Pipelines of GitLab Repositories. see https://gitlab.com/dexpi/Specification as the main used Repository

CI/CD & Release Process

The project uses GitLab CI/CD for testing and publishing:

  1. Testing
    Unit tests run automatically on every commit and merge request. Builds must pass before deployment.

  2. Publish to TestPyPI
    Development builds are uploaded to TestPyPI for pre-release testing.

  3. Publish to PyPI
    Tagged releases or main branch builds are uploaded to PyPI.
    API tokens are securely stored in GitLab CI/CD variables.

  4. Versioning
    Follows Semantic Versioning (MAJOR.MINOR.PATCH).


Contributing

  • Open a merge request with your changes
  • Include tests for new functionality or bug fixes
  • Follow code review feedback before merging

Issues

Report issues and feature requests in the GitLab issue tracker.


License

This project is licensed under the LICENSE file included in the repository.

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

dexpi_specificator-1.0.0.tar.gz (53.9 kB view details)

Uploaded Source

Built Distribution

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

dexpi_specificator-1.0.0-py3-none-any.whl (59.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dexpi_specificator-1.0.0.tar.gz
  • Upload date:
  • Size: 53.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for dexpi_specificator-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f079d8f3c600fba76cf09a13a413a4bf5086c6a189eba18d030c212342e6bb21
MD5 a9c8732a0ce27fd6ab0bbba4bb913fb8
BLAKE2b-256 e674e3f906c458941d3e65607ef139005a2bb1cac5dcefa3dcfbefb641988e8e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dexpi_specificator-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae5b6ff826d73999addeedf047e0bf8cfba8d3a98c2849945f26747524e7296d
MD5 3b6ea2b9f2116da698503cf7ccadfdfa
BLAKE2b-256 bb4919d2c12bb86a1d79716f45a56b873707e71847e5e25f58cf0c2ff4e2f828

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