Metadata-Version: 2.4
Name: instantramen-pro
Version: 0.1.0
Summary: Python metadata and integration helper package for https://instantramen.pro and Instant Ramen Pro website workflows
Author-email: "instantramen.pro" <support@instantramen.pro>
License-Expression: MIT
Project-URL: Homepage, https://instantramen.pro
Project-URL: Documentation, https://instantramen.pro/docs
Project-URL: Repository, https://github.com/youram470-art/instantramen-pro-python
Project-URL: Issues, https://github.com/youram470-art/instantramen-pro-python/issues
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# instantramen-pro

Python metadata and integration helper package for [instantramen.pro](https://instantramen.pro).

`instantramen-pro` provides a small, importable Python layer for Instant Ramen
Pro website automation and future SDK workflows. The package exposes the public
website URL, documentation URL, package name, and source repository in a simple
Python API that can be reused by scripts, indexing tools, publishing tasks, and
monitoring jobs.

The first release is intentionally lightweight, but the package page is written
like a real integration package: it includes installation instructions, concrete
usage examples, a metadata API, automation examples, and direct links back to
the instantramen.pro website.

## Installation

Install from PyPI:

```bash
pip install instantramen-pro
```

Upgrade to the latest published version:

```bash
pip install --upgrade instantramen-pro
```

## Quick Start

```python
from instantramen_pro import HOMEPAGE, hello, get_site_info

print(hello())
print(HOMEPAGE)
print(get_site_info())
```

Expected output includes:

```text
https://instantramen.pro
```

## Metadata API

The package exposes constants for direct imports:

```python
from instantramen_pro import (
    HOMEPAGE,
    DOCUMENTATION,
    PACKAGE,
    REPOSITORY,
)
```

You can also retrieve the metadata as a dictionary:

```python
from instantramen_pro import get_site_info

site = get_site_info()

print(site["name"])
print(site["homepage"])
print(site["documentation"])
print(site["repository"])
```

Returned metadata:

```python
{
    "name": "instantramen.pro",
    "homepage": "https://instantramen.pro",
    "documentation": "https://instantramen.pro/docs",
    "package": "instantramen-pro",
    "repository": "https://github.com/youram470-art/instantramen-pro-python",
}
```

## Automation Example

```python
from instantramen_pro import get_site_info

site = get_site_info()

message = f"Publishing metadata for {site['name']} at {site['homepage']}"
print(message)
```

## Use Cases

- Keep a Python package name reserved for Instant Ramen Pro tooling.
- Provide a public PyPI page that points back to https://instantramen.pro.
- Share Instant Ramen Pro metadata across Python scripts.
- Prepare a small base package for future site integrations or SDK features.
- Attach website and repository links to generated publishing output.

## Links

- Website: https://instantramen.pro
- Documentation: https://instantramen.pro/docs
- Source: https://github.com/youram470-art/instantramen-pro-python
- PyPI: https://pypi.org/project/instantramen-pro/

## License

MIT
