sporniket/moto-tools

A python library with a set of command line interfaces that will assist a developper of software running on emulators of the family of computers made by Thomson during the 1980s, models "MO" and models "TO"

Sporniket's MO/TO tools

[WARNING] Please read carefully this note before using this project. It contains important facts.

Content

1. What is Sporniket's MO/TO tools, and when to use it ?
2. What should you know before using Sporniket's MO/TO tools ?
3. How to use Sporniket's MO/TO tools ?
4. Known issues
5. Miscellanous

1. What is Sporniket's MO/TO tools, and when to use it ?

Sporniket's MO/TO tools is a python library with a set of command line interfaces that will assist a developper of software running on emulators of the family of computers made by Thomson during the 1980s, models "MO" and models "TO".

Licence

Sporniket's MO/TO tools is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Sporniket's MO/TO tools is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Release notes

v0.0.3

• Resolves #6 [moto_prettier] force upper case outside litteral string

v0.0.2

• Resolves #4 : [moto_tar][mo5] adjust the minimal sequence to spot the start of a bloc
• Resolves #5 : [moto_bas2lst] Convert basic ascii file to plain text utf-8 file (#9)
• Resolves #7 : [moto_lst2bas] Convert plain text files into ASCII basic

v0.0.1

The target platform is Thomson MO5.

Provides the following tools :

• moto_tar : create, list or extract files to or from a tape archive format ; the command line interface is designed after the command tar.
• moto_nl : number the lines of a basic source that have line numbers ; the command line interface is designed after the command nl.

2. What should you know before using Sporniket's MO/TO tools ?

Sporniket's MO/TO tools is written using python version 3.8, and should work with python version to 3.10.

It relies on the following packages to build and test :

• build
• pytest
• coverage

It also relies on the following package to enforce source formatting :

• black

see README packaging for further details.

Do not use Sporniket's MO/TO tools if this project is not suitable for your project.

3. How to use Sporniket's MO/TO tools ?

From sources

To get the latest available models, one must clone the git repository, build and install the package.

git clone https://github.com/sporniket/moto-tools.git
cd moto-tools
./retest

Then, invoke one of the command line interfaces :

python3 -m moto_tools_tar [option] input_file

Using pip

pip install moto-tools-by-sporniket

Then, invoke the command line interface :

python3 -m moto_tools_tar [option] input_file

4. Known issues

See the project issues page.

5. Miscellanous

Supplemental documentation :

• README packaging : some technical details about packaging this project.
• README cli tar : the manual of the command line interface moto_tar.
• README cli nl : the manual of the command line interface moto_nl.
• README cli bas2lst : the manual of the command line interface moto_bas2lst.
• README cli lst2bas : the manual of the command line interface moto_lst2bas.
• README cli prettier : the manual of the command line interface moto_prettier.
• Tape archive format : the description of the format.

Report issues

Use the project issues page.