atari-8-bit-utils


Nameatari-8-bit-utils JSON
Version 0.2.8 PyPI version JSON
download
home_pageNone
SummaryA collection of Python utilities for projects related to Atari 8-bit computers
upload_time2024-11-13 16:33:22
maintainerNone
docs_urlNone
authorJohan van Rensburg
requires_python>=3.8
licenseNone
keywords atascii atari
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Atari 8-bit Python Utilities
[![PyPI version](https://img.shields.io/pypi/v/atari-8-bit-utils)](https://pypi.org/project/atari-8-bit-utils/)![Auto Tag badge](https://github.com/JSJvR/atari-8-bit-utils/actions/workflows/auto_tag.yml/badge.svg) ![Python Package badge](https://github.com/JSJvR/atari-8-bit-utils/actions/workflows/python-package.yml/badge.svg) ![Python Publish badge](https://github.com/JSJvR/atari-8-bit-utils/actions/workflows/python-publish.yml/badge.svg) 

## Prerequisites

- Python 3.8 or later
- Optional: A version of [`mkatr`](https://github.com/dmsc/mkatr) compiled for you platform, in your `PATH`. Needed for `atr2git` command to work. 

## Getting Started

The package can be installed using `pip`

```
pip install atari-8-bit-utils
```

Verify the installation by running `a8utils --help`

The output should look something like this

```
 Usage: a8utils [OPTIONS] COMMAND [ARGS]...

╭─ Options ────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current     │
│                               shell.                                 │
│ --show-completion             Show completion for the current shell, │
│                               to copy it or customize the            │
│                               installation.                          │
│ --help                        Show this message and exit.            │
╰──────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────╮
│ ata2utf    Converts a single file or all files in a directory from   │
│            ATASCII to UTF-8                                          │
│ utf2ata    Converts a single file or all files in a directory from   │
│            UTF-8 to ATASCII                                          │
│ atr2git    Keeps an ATR image and git repo in sync                   │
╰──────────────────────────────────────────────────────────────────────╯
```

## Commands

TODO

## Demo

The best way to make full use of this project is to start with the [Atari 8-bit Git template](https://github.com/JSJvR/atari-8-bit-git-template)

https://github.com/user-attachments/assets/e0558c34-0741-4e70-920e-98a72fade00e

The video shows [this commit](https://github.com/JSJvR/atari-8-bit-git-template/commit/14f69b4393901dea558b4a9ecce9b8b7189de932) being made from my Atari. Note that the [BASIC listing](https://github.com/JSJvR/atari-8-bit-git-template/blob/367d22375184d9a73c7c38c9ff049913a7ef558b/utf8/LOVE.LST) and the commit message both contain a "♥" which is `0x00` in ATASCII and therefore not valid in a standard text file. ATASCII characters get translated automatically to their [closest Unicode equivalent](https://www.kreativekorp.com/charset/map/atascii/).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "atari-8-bit-utils",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "ATASCII, Atari",
    "author": "Johan van Rensburg",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/09/3f/99e0b525e12fda5763d9ab26d69498a2357faa429ea6b352ad76b361696e/atari_8_bit_utils-0.2.8.tar.gz",
    "platform": null,
    "description": "# Atari 8-bit Python Utilities\n[![PyPI version](https://img.shields.io/pypi/v/atari-8-bit-utils)](https://pypi.org/project/atari-8-bit-utils/)![Auto Tag badge](https://github.com/JSJvR/atari-8-bit-utils/actions/workflows/auto_tag.yml/badge.svg) ![Python Package badge](https://github.com/JSJvR/atari-8-bit-utils/actions/workflows/python-package.yml/badge.svg) ![Python Publish badge](https://github.com/JSJvR/atari-8-bit-utils/actions/workflows/python-publish.yml/badge.svg) \n\n## Prerequisites\n\n- Python 3.8 or later\n- Optional: A version of [`mkatr`](https://github.com/dmsc/mkatr) compiled for you platform, in your `PATH`. Needed for `atr2git` command to work. \n\n## Getting Started\n\nThe package can be installed using `pip`\n\n```\npip install atari-8-bit-utils\n```\n\nVerify the installation by running `a8utils --help`\n\nThe output should look something like this\n\n```\n Usage: a8utils [OPTIONS] COMMAND [ARGS]...\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --install-completion          Install completion for the current     \u2502\n\u2502                               shell.                                 \u2502\n\u2502 --show-completion             Show completion for the current shell, \u2502\n\u2502                               to copy it or customize the            \u2502\n\u2502                               installation.                          \u2502\n\u2502 --help                        Show this message and exit.            \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 ata2utf    Converts a single file or all files in a directory from   \u2502\n\u2502            ATASCII to UTF-8                                          \u2502\n\u2502 utf2ata    Converts a single file or all files in a directory from   \u2502\n\u2502            UTF-8 to ATASCII                                          \u2502\n\u2502 atr2git    Keeps an ATR image and git repo in sync                   \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\n## Commands\n\nTODO\n\n## Demo\n\nThe best way to make full use of this project is to start with the [Atari 8-bit Git template](https://github.com/JSJvR/atari-8-bit-git-template)\n\nhttps://github.com/user-attachments/assets/e0558c34-0741-4e70-920e-98a72fade00e\n\nThe video shows [this commit](https://github.com/JSJvR/atari-8-bit-git-template/commit/14f69b4393901dea558b4a9ecce9b8b7189de932) being made from my Atari. Note that the [BASIC listing](https://github.com/JSJvR/atari-8-bit-git-template/blob/367d22375184d9a73c7c38c9ff049913a7ef558b/utf8/LOVE.LST) and the commit message both contain a \"\u2665\" which is `0x00` in ATASCII and therefore not valid in a standard text file. ATASCII characters get translated automatically to their [closest Unicode equivalent](https://www.kreativekorp.com/charset/map/atascii/).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A collection of Python utilities for projects related to Atari 8-bit computers",
    "version": "0.2.8",
    "project_urls": {
        "Documentation": "https://github.com/JSJvR/atari-8-bit-utils#readme",
        "Issues": "https://github.com/JSJvR/atari-8-bit-utils/issues",
        "Source": "https://github.com/JSJvR/atari-8-bit-utils"
    },
    "split_keywords": [
        "atascii",
        " atari"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f131e745e618ec328d2b2ad7d386be8eee228f44c3cf32c148e66f779b711af4",
                "md5": "049c8947ace35a777e7642149d71d3ca",
                "sha256": "714c97ca5a179ee9d538bc909154d6ddc341d07eeb70926556021bec1d1e95b0"
            },
            "downloads": -1,
            "filename": "atari_8_bit_utils-0.2.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "049c8947ace35a777e7642149d71d3ca",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 17537,
            "upload_time": "2024-11-13T16:33:21",
            "upload_time_iso_8601": "2024-11-13T16:33:21.826110Z",
            "url": "https://files.pythonhosted.org/packages/f1/31/e745e618ec328d2b2ad7d386be8eee228f44c3cf32c148e66f779b711af4/atari_8_bit_utils-0.2.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "093f99e0b525e12fda5763d9ab26d69498a2357faa429ea6b352ad76b361696e",
                "md5": "7b2ec3717f1df5d018f3eba1190df798",
                "sha256": "6fc0cecc67ed248259a228ec3cce2a58b0ac323e372a5ada236d347a7957d01a"
            },
            "downloads": -1,
            "filename": "atari_8_bit_utils-0.2.8.tar.gz",
            "has_sig": false,
            "md5_digest": "7b2ec3717f1df5d018f3eba1190df798",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 18154,
            "upload_time": "2024-11-13T16:33:22",
            "upload_time_iso_8601": "2024-11-13T16:33:22.844030Z",
            "url": "https://files.pythonhosted.org/packages/09/3f/99e0b525e12fda5763d9ab26d69498a2357faa429ea6b352ad76b361696e/atari_8_bit_utils-0.2.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-13 16:33:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "JSJvR",
    "github_project": "atari-8-bit-utils#readme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "atari-8-bit-utils"
}
        
Elapsed time: 8.78344s