Metadata-Version: 2.1
Name: ios-shell
Version: 1.0.0
Summary: Parses files formatted by the Institute of Ocean Sciences' IOSShell tool
Home-page: https://github.com/cyborgsphinx/ios-shell
License: MIT
Keywords: ocean,science,parse
Author: James Hannah
Author-email: jhannah@protonmail.com
Requires-Python: >=3.8,<3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Text Processing :: General
Requires-Dist: fortranformat (>=1.0.1,<2.0.0)
Project-URL: Documentation, https://ios-shell.readthedocs.io
Project-URL: Repository, https://github.com/cyborgsphinx/ios-shell
Description-Content-Type: text/markdown

# IOS Shell file parsing library

This is a library for parsing files in the IOS Shell format.
It has no relation to iOS or terminal shells.

## Prerequisites

- Python 3.8, 3.9, or 3.10 with pip

## Installation

`ios_shell` is not yet on PyPI.
To use it in your project, you can run the following:

    pip install -e git+https://github.com/cyborgsphinx/ios-shell#egg=ios_shell

## Example

If `1930-003-0058.bot` is in the same folder as the program using ios_shell:

    parsed_file = ios_shell.ShellFile.fromfile("1930-003-0058.bot")

To use the contents of a file previously read into the program:

    parsed_contents = ios_shell.ShellFile.fromcontents(contents)

