========================= No Longer Supported =========================

This project has reached the end of development and is no longer supported

What this means now

The repository, issues, pull requests, labels, milestones, projects, wiki, releases, commits, tags, branches, reactions and comments are read-only.
The repository can still be forked and cloned - The License still applies.

What this means in the future

The repository is scheduled for deletion (the earliest date for this is 01/07/2021)
The repository may be un-archived (however, this is very unlikely)

========================= No Longer Supported =========================

MiniEncoding

Ascii representations. Stores ascii as a bitarray in ascii8 form.

Encodings

miniencoding.asciibytes AsciiBytes

Encoding	To	From
Ascii8	✔	✔
Ascii7	✔	✔
DecSixBit	✔	✔
ICL*	✔	✔
SixBitAscii	✔	✔

* ↑ and	← not supported instead uses ^ and _

miniencoding.tables

Encode to a charset with:

def toCharset(charset, string, toUpper=False):
	"""Convert unicode text to various charsets using a lookup table

	Args:
		charset (string): lookup table
		string (string): unicode string to convert
		toUpper (bool, optional): Make chars uppercase before converting
		(intended for 6 bit charsets or charsets that do not support uppercase).
		Defaults to False.

	Returns:
		bytes: sequence of bytes (split into bits of length
	"""

Decode from a charset to Unicode with:

def toUnicode(charset, bytestream):
	"""Convert text encoded with various charsets to unicode using a charset
	lookup table

	Args:
		charset (string): lookup table
		bytestream (bytes): sequence of bytes (split into bits of length
		log2(len(charset))) to convert

	Returns:
		string: unicode string
	"""

Available charsets (or make your own):

# CDC 1604: Magnetic tape BCD codes
CDC1604_MAGTAPE
# CDC 1604: Punched card codes
CDC1604_PUNCHCARD
# CDC 1612: Printer codes (business applications)
CDC1612
# DEC SIXBIT
DEC_SIXBIT
# ECMA-1
EMCA1
# ICL Mainframes
ICL
# SixBit ASCII (used by AIS)
SIXBIT
# GOST 10859 § 6-bit code: with only Cyrillic upper case letters
GOST
# GSM 7-bit default alphabet and extension table of 3GPP TS 23.038 / GSM 03.38
GSM7
# ASCII
ASCII7
# IBM 48-character BCDIC code
IBM48
# IBM 704 BCD code
IBM704
# IBM 7090/7094 character set
IBM7090
# IBM 1401 BCD code
IBM1401
# GBCD code
GBCD
# Burroughs B5500 BCD code
BURROUGHS_B5500
# Code page 353
CP353
# Code page 355
CP355
# Code page 357
CP357
# Code page 358
CP358
# Code page 359/360
CP359

For more info see https://en.wikipedia.org/wiki/Six-bit_character_code#Types_of_six-bit_codes

Encodings
- miniencoding.asciibytes AsciiBytes
- miniencoding.tables
Documentation
Install With PIP
Language information
- Built for
Install Python on Windows
- Chocolatey
- Download
Install Python on Linux
- Apt
How to run
- With VSCode
- From the Terminal
Download Project
- Clone
  - Using The Command Line
  - Using GitHub Desktop
- Download Zip File
Community Files
- Licence
- Changelog
- Code of Conduct
- Contributing
- Security
- Support
- Rationale

Documentation

See the Docs for more information.

Install With PIP

pip install miniencoding

Head to https://pypi.org/project/miniencoding/ for more info

Language information

Built for

This program has been written for Python 3 and has been tested with Python version 3.9.0 https://www.python.org/downloads/release/python-380/.

Install Python on Windows

Chocolatey

choco install python

Download

To install Python, go to https://www.python.org/ and download the latest version.

Install Python on Linux

Apt

sudo apt install python3.9

How to run

With VSCode

Open the .py file in vscode
Ensure a python 3.9 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.9)
Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)

From the Terminal

./[file].py

Download Project

Clone

Using The Command Line

Press the Clone or download button in the top right
Copy the URL (link)
Open the command line and change directory to where you wish to clone to
Type 'git clone' followed by URL in step 2

$ git clone https://github.com/FHPythonUtils/MiniEncoding

More information can be found at https://help.github.com/en/articles/cloning-a-repository

Using GitHub Desktop

Press the Clone or download button in the top right
Click open in desktop
Choose the path for where you want and click Clone

More information can be found at https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

Download Zip File

Download this GitHub repository
Extract the zip archive
Copy/ move to the desired location

Community Files

Licence

MIT License Copyright (c) FredHappyface (See the LICENSE for more information.)

Changelog

See the Changelog for more information.

Code of Conduct

Online communities include people from many backgrounds. The Project contributors are committed to providing a friendly, safe and welcoming environment for all. Please see the Code of Conduct for more information.

Contributing

Contributions are welcome, please see the Contributing Guidelines for more information.

Security

Thank you for improving the security of the project, please see the Security Policy for more information.

Support

Thank you for using this project, I hope it is of use to you. Please be aware that those involved with the project often do so for fun along with other commitments (such as work, family, etc). Please see the Support Policy for more information.

Rationale

The rationale acts as a guide to various processes regarding projects such as the versioning scheme and the programming styles used. Please see the Rationale for more information.

FHArchive/MiniEncoding