Metadata-Version: 2.4
Name: ortelic
Version: 0.0.1
Summary: The Python entry point for the Ortelic organisation.
License-Expression: MIT
License-File: LICENSE
Keywords: ortelic
Author: Ortelic
Author-email: info@ortelic.com
Maintainer: Lars van Vianen
Maintainer-email: lars@ortelic.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Project-URL: Homepage, https://github.com/ortelic
Description-Content-Type: text/markdown

# Ortelic

**The Python entry point for the Ortelic organisation.**

[![PyPI version](https://img.shields.io/pypi/v/ortelic.svg)](https://pypi.org/project/ortelic/)
[![Python versions](https://img.shields.io/pypi/pyversions/ortelic.svg)](https://pypi.org/project/ortelic/)
[![License](https://img.shields.io/pypi/l/ortelic.svg)](https://pypi.org/project/ortelic/)

---

## Installation

Install Ortelic using pip:

```bash
pip install ortelic
```

---

## Quick Start

```python
from ortelic import about

info = about()

print(info["name"])          # ortelic
print(info["organisation"])  # Ortelic
print(info["version"])       # the installed version
```

```python
from ortelic import __version__, __version_info__

print(__version__)                  # '0.0.1'
print(__version_info__ >= (0, 0, 1))  # True
```

---

## Command-Line Interface

Ortelic ships a console script:

```bash
# Human-readable report
ortelic

# Machine-readable report
ortelic --json

# Show version
ortelic --version

# Help
ortelic --help
```

`python -m ortelic` works identically.

---

## Status

This is an early release. It establishes the distribution, its typed surface
and its command line; the public API is still taking shape, so **pin an exact
version** if you depend on it.

---

## API Reference

### `about() -> dict[str, str]`

Describe this distribution.

**Returns:**

- `dict[str, str]`: a mapping of `name`, `version`, `organisation`, `status`,
  `summary`, `license`, `homepage` and `contact`.

Every value is read from the package's version module, except `version`, which
comes from the installed distribution metadata so that what is reported is what
is actually installed.

---

## Requirements

- Python >= 3.10, < 4.0
- No runtime dependencies

---

## License

MIT. Copyright © 2026 Ortelic.

---

## Links

- **Homepage**: [https://github.com/ortelic](https://github.com/ortelic)
- **PyPI**: [https://pypi.org/project/ortelic/](https://pypi.org/project/ortelic/)

---

## Support

For questions and support, please contact
[lars@ortelic.com](mailto:lars@ortelic.com).

---

**Made with ♥ by Ortelic**

