Skip to main content

The ASD-STE100 (Simplified Technical English) Issue 9 vocabulary.

Project description

biz.dfch.AsdSte100Vocab

ASD-STE100: Issue 9 License: AGPL v3 Python Pylint and unittest TestPyPI version PyPI version PyPI downloads

Introduction

This is a Python library, that implements an ASD-STE100 Issue 9 compatible dictionary, that includes the Technical Nouns (TN) and Technical Verbs (TV) from the rule R1.5 and rule R1.12. A word has these properties:

  • name, the name of a word item
  • status, is this word APPROVED or REJECTED?
  • source, where does this word come from?
  • type_, the word type (similar to "part of speech")
  • category, the TN or TV category or "default"
  • spellings, all correct spellings of the Word item (this is not a "lemma")
  • meanings, contains one or more meanings for an APPROVED word item
  • alternatives, a list that contains one or more alternatives for a REJECTED word item
  • note, an optional note for Word item
  • ste_example, an example that shows how to use the Word item correctly
  • nonste_example, an example that shows an incorrect use of the Word item

biz.dfch.AsdSte100Lookup uses this library for its word lists and the display of these words.

Installation

biz-dfch-ste100vocab is on PyPI. Create a virtual environment and install the library with pip:

pip install biz-dfch-ste100vocab

Or install with uv:

uv add biz-dfch-ste100vocab

Create your own vocabulary entries

When you want to create your own word entries, you install the dev dependencies:

uv sync --extra dev
# or
uv pip install -e ".[dev]"
# or
pip install -e ".[dev]"

Then use this command:

uv run vocab new
image

You can use an .env file (or environment variables, see --help) to define recurring parameters (see example below) and you can use --interactive (or -i) for an interactive wizard. Each time you start the program, it will create a new JSONL entry.

The specified file must exist. The program will only append to an existing file, but not create a new file.

Example .env file

cat .env
VOCAB_STATUS=approved
VOCAB_SOURCE=ARBITRARY-SOURCE
VOCAB_TYPE=TN
VOCAB_CATEGORY=TN21
VOCAB_FILE=./vocab.jsonl

License

This library is licensed under the GNU Affero General Public License. See LICENSE for more information.

ASD-STE100 Simplified Technical English (Standard for Technical Documentation), Issue 9

Copyright 2025 Aerospace, Security and Defence Industries Association of Europe (ASD), https://www.asd-europe.org.

This library or the maintainer is not affiliated with ASD. ASD does not endorse this library or the maintainer.

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

biz_dfch_ste100vocab-0.7.0.tar.gz (496.2 kB view details)

Uploaded Source

Built Distribution

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

biz_dfch_ste100vocab-0.7.0-py3-none-any.whl (523.9 kB view details)

Uploaded Python 3

File details

Details for the file biz_dfch_ste100vocab-0.7.0.tar.gz.

File metadata

  • Download URL: biz_dfch_ste100vocab-0.7.0.tar.gz
  • Upload date:
  • Size: 496.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for biz_dfch_ste100vocab-0.7.0.tar.gz
Algorithm Hash digest
SHA256 90cd89f485255d17d09a7a05c53d54c0519de0de5fb7cd21bdd91d2695841c99
MD5 e67923637410c656de0175f049ef4a71
BLAKE2b-256 38e7bfc98a03e8499af559fc35c4a68787a5afbc8f475447288acbaa4fc7990f

See more details on using hashes here.

Provenance

The following attestation bundles were made for biz_dfch_ste100vocab-0.7.0.tar.gz:

Publisher: publish.yml on dfch/biz.dfch.AsdSte100Vocab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file biz_dfch_ste100vocab-0.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for biz_dfch_ste100vocab-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 181c6151a7f50363f11a72d4803fe9a3687601b621f801bfc2f4f2ae7336a97a
MD5 4e5681fcab49783e013999f67ade7f68
BLAKE2b-256 39e10aab4105c8af9640dcc53dc73f11ead63da15c574a0deb85eca13fd3f3dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for biz_dfch_ste100vocab-0.7.0-py3-none-any.whl:

Publisher: publish.yml on dfch/biz.dfch.AsdSte100Vocab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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