Metadata-Version: 2.1
Name: ocxtools
Version: 1.3.0
Summary: Python utility CLI for working with 3Docx models.
Author: ocastrup
Author-email: ole.christian.astrup@dnv.com
Requires-Python: >=3.11,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: arrow
Requires-Dist: click
Requires-Dist: click_shell
Requires-Dist: httpx
Requires-Dist: loguru
Requires-Dist: lxml
Requires-Dist: ocx (==3.00b5)
Requires-Dist: ocx_schema_parser
Requires-Dist: packaging (>=23.1,<24.0)
Requires-Dist: pandas
Requires-Dist: rich
Requires-Dist: soap
Requires-Dist: tbump
Requires-Dist: typer
Description-Content-Type: text/markdown

# ocxtools
> ### A python CLI to work with 3Docx models.

``ocxtools`` is a configurable Python CLI shell with pluggable subcommands. The CLI combines features from [``click``](https://click.palletsprojects.com/en/8.1.x/),
[``click-shell``](https://click-shell.readthedocs.io/en/latest/), [``typer``](https://typer.tiangolo.com/) and [``Rich``](https://rich.readthedocs.io/en/stable/introduction.html)
with emphasis on **Typer** and **Rich** to make a good-looking CLI.

## Installation

install from pypi:
````commandline
pip install ocxtools
````

# Usage
## The main CLI

````commandline

             ,----..
            /   /   \    ,----..   ,--,     ,--,
           /   .     :  /   /   \  |'. \   / .`|
          .   /   ;.  \|   :     : ; \ `\ /' / ;
         .   ;   /  ` ;.   |  ;. / `. \  /  / .'          ______   ___    ___   _     _____
         ;   |  ; \ ; |.   ; /--`   \  \/  / ./          |      | /   \  /   \ | |   / ___/
         |   :  | ; | ';   | ;       \  \.'  /     _____ |      ||     ||     || |  (   \_
         .   |  ' ' ' :|   : |        \  ;  ;     |     ||_|  |_||  O  ||  O  || |___\__  |
         '   ;  \; /  |.   | '___    / \  \  \    |_____|  |  |  |     ||     ||     /  \ |
          \   \  ',  / '   ; : .'|  ;  /\  \  \            |  |  |     ||     ||     \    |
           ;   :    /  '   | '/  :./__;  \  ;  \           |__|   \___/  \___/ |_____|\___|
            \   \ .'   |   :    / |   : / \  \  ;
             `---`      \   \ .'  ;   |/   \  ' |
                         `---`    `---'     `--`

Version: 1.1.0
Copyright (c) 2024. OCX Consortium (https://3docx.org)

Starting ocxtools...
ocxtools >: help

Documented commands (type help <topic>):
========================================
clear  docker  validate  version

Undocumented commands:
======================
exit  help  quit


ocxtools >:

````
## Shell Completion
Command completion is not supported on Windows installations.

## Sub-commands
### [docker](readme/docker.md)

### [validate](readme/validate.md)

# Changelog
[Changelog](CHANGELOG.md)

## API

The API documentation is autogenerated using ``sphinx`` and the Read The Docs theme:

https://ocxstandard.github.io/ocxtools/

