ossin


Nameossin JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryWhat is OS's sin? 🤔 A beautiful system information utility that displays basic information about your operating system, Python environment, and platform details using Rich for stunning terminal output.
upload_time2025-08-16 13:52:07
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords cli command-line information monitoring ossin system utility
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ossin

[![PyPI - Version](https://img.shields.io/pypi/v/ossin.svg)](https://pypi.org/project/ossin)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ossin.svg)](https://pypi.org/project/ossin)

What is OS's sin? 🤔 A beautiful system information utility that displays basic information about your operating system, Python environment, and platform details using Rich for stunning terminal output.

---

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
- [Development](#development)
- [License](#license)

## Installation

```sh
uv add ossin
```

## Usage

### Basic Usage

Display system information in the default table format:

```sh
ossin
```

### Output Formats

Choose from different output formats:

**Table format (default):**

```sh
ossin --format table
```

**Panel format:**

```sh
ossin --format panels
```

**JSON format:**

```sh
ossin --format json
```

### Options

- `--format, -f`: Output format (`table`, `panels`, `json`) [default: table]
- `--no-color`: Disable colored output
- `--version`: Show version and exit
- `--help`: Show help message

### Examples

```sh
# Display system info in table format
ossin

# Display system info in panel format
ossin --format panels

# Display system info in JSON format
ossin --format json

# Display without colors
ossin --no-color

# Show version
ossin --version

# Show help
ossin --help
```

## Features

- **Beautiful Output**: Uses Rich library for stunning terminal formatting
- **Multiple Formats**: Support for table, panel, and JSON output formats
- **System Information**: Displays OS name, version, architecture, and platform details
- **Python Environment**: Shows Python version and implementation details
- **Modern CLI**: Built with Typer for excellent CLI experience with type hints and auto-completion
- **Cross-platform**: Works on Windows, macOS, and Linux

<!-- xc-heading -->
## Development

Clone the repository and cd into the project directory:

```sh
git clone https://github.com/python-ankara-toplulugu/ossin
cd ossin
```

The commands below can also be executed using the [xc task runner](https://xcfile.dev/), which combines the usage instructions with the actual commands. Simply run `xc`, it will pop up an interactive menu with all available tasks.

### `install`

Install the dependencies:

```sh
uv sync
```

### `start`

Start the CLI:

```sh
uv run ossin
```

### `test`

Run the tests:

```sh
uv run pytest
```

### `ci`

Run the linters and type checkers:

```sh
uv run ruff check
uv run ruff format
uv run mypy
uv run ty check
uv run pyrefly check
uv run pyright
uv run vulture
uv run validate-pyproject pyproject.toml
```

## License

`ossin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ossin",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Hasan Sezer Ta\u015fan <hasansezertasan@gmail.com>",
    "keywords": "cli, command-line, information, monitoring, ossin, system, utility",
    "author": null,
    "author_email": "Hasan Sezer Ta\u015fan <hasansezertasan@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/34/98/a851b2cad8246bbfd93d55ebbf055115b12857e0d1adcfac7bdab0da9385/ossin-0.1.0.tar.gz",
    "platform": null,
    "description": "# ossin\n\n[![PyPI - Version](https://img.shields.io/pypi/v/ossin.svg)](https://pypi.org/project/ossin)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ossin.svg)](https://pypi.org/project/ossin)\n\nWhat is OS's sin? \ud83e\udd14 A beautiful system information utility that displays basic information about your operating system, Python environment, and platform details using Rich for stunning terminal output.\n\n---\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Features](#features)\n- [Development](#development)\n- [License](#license)\n\n## Installation\n\n```sh\nuv add ossin\n```\n\n## Usage\n\n### Basic Usage\n\nDisplay system information in the default table format:\n\n```sh\nossin\n```\n\n### Output Formats\n\nChoose from different output formats:\n\n**Table format (default):**\n\n```sh\nossin --format table\n```\n\n**Panel format:**\n\n```sh\nossin --format panels\n```\n\n**JSON format:**\n\n```sh\nossin --format json\n```\n\n### Options\n\n- `--format, -f`: Output format (`table`, `panels`, `json`) [default: table]\n- `--no-color`: Disable colored output\n- `--version`: Show version and exit\n- `--help`: Show help message\n\n### Examples\n\n```sh\n# Display system info in table format\nossin\n\n# Display system info in panel format\nossin --format panels\n\n# Display system info in JSON format\nossin --format json\n\n# Display without colors\nossin --no-color\n\n# Show version\nossin --version\n\n# Show help\nossin --help\n```\n\n## Features\n\n- **Beautiful Output**: Uses Rich library for stunning terminal formatting\n- **Multiple Formats**: Support for table, panel, and JSON output formats\n- **System Information**: Displays OS name, version, architecture, and platform details\n- **Python Environment**: Shows Python version and implementation details\n- **Modern CLI**: Built with Typer for excellent CLI experience with type hints and auto-completion\n- **Cross-platform**: Works on Windows, macOS, and Linux\n\n<!-- xc-heading -->\n## Development\n\nClone the repository and cd into the project directory:\n\n```sh\ngit clone https://github.com/python-ankara-toplulugu/ossin\ncd ossin\n```\n\nThe commands below can also be executed using the [xc task runner](https://xcfile.dev/), which combines the usage instructions with the actual commands. Simply run `xc`, it will pop up an interactive menu with all available tasks.\n\n### `install`\n\nInstall the dependencies:\n\n```sh\nuv sync\n```\n\n### `start`\n\nStart the CLI:\n\n```sh\nuv run ossin\n```\n\n### `test`\n\nRun the tests:\n\n```sh\nuv run pytest\n```\n\n### `ci`\n\nRun the linters and type checkers:\n\n```sh\nuv run ruff check\nuv run ruff format\nuv run mypy\nuv run ty check\nuv run pyrefly check\nuv run pyright\nuv run vulture\nuv run validate-pyproject pyproject.toml\n```\n\n## License\n\n`ossin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "What is OS's sin? \ud83e\udd14 A beautiful system information utility that displays basic information about your operating system, Python environment, and platform details using Rich for stunning terminal output.",
    "version": "0.1.0",
    "project_urls": {
        "changelog": "https://github.com/python-ankara-toplulugu/ossin/blob/main/CHANGELOG.md",
        "documentation": "https://github.com/python-ankara-toplulugu/ossin#readme",
        "homepage": "https://github.com/python-ankara-toplulugu/ossin",
        "issues": "https://github.com/python-ankara-toplulugu/ossin/issues",
        "releasenotes": "https://github.com/python-ankara-toplulugu/ossin/releases",
        "source": "https://github.com/python-ankara-toplulugu/ossin.git"
    },
    "split_keywords": [
        "cli",
        " command-line",
        " information",
        " monitoring",
        " ossin",
        " system",
        " utility"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d59cf4ec4456f225544cd518e36761e0e2baf43192d559fc74da4b8002af0bad",
                "md5": "1dbf1635b6f3a519b9286a784131ffe7",
                "sha256": "1eb741e3566bdb4f9bafe601d0c1a31459336ddefbf72da39337c07a2e9d9339"
            },
            "downloads": -1,
            "filename": "ossin-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1dbf1635b6f3a519b9286a784131ffe7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7517,
            "upload_time": "2025-08-16T13:52:06",
            "upload_time_iso_8601": "2025-08-16T13:52:06.758792Z",
            "url": "https://files.pythonhosted.org/packages/d5/9c/f4ec4456f225544cd518e36761e0e2baf43192d559fc74da4b8002af0bad/ossin-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3498a851b2cad8246bbfd93d55ebbf055115b12857e0d1adcfac7bdab0da9385",
                "md5": "bc4b928bce2fd8a14aee117d4e11b31a",
                "sha256": "286c8ee18d8000e80d5e443fc0dbcd481f2a45ebda7404d801091a2e9d5d249d"
            },
            "downloads": -1,
            "filename": "ossin-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bc4b928bce2fd8a14aee117d4e11b31a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 33075,
            "upload_time": "2025-08-16T13:52:07",
            "upload_time_iso_8601": "2025-08-16T13:52:07.853442Z",
            "url": "https://files.pythonhosted.org/packages/34/98/a851b2cad8246bbfd93d55ebbf055115b12857e0d1adcfac7bdab0da9385/ossin-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-16 13:52:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "python-ankara-toplulugu",
    "github_project": "ossin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "ossin"
}
        
Elapsed time: 1.14035s