instantramen-pro 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. instantramen_pro-0.1.0/PKG-INFO +125 -0
  2. instantramen_pro-0.1.0/README.md +112 -0
  3. instantramen_pro-0.1.0/pyproject.toml +21 -0
  4. instantramen_pro-0.1.0/setup.cfg +4 -0
  5. instantramen_pro-0.1.0/src/instantramen_pro/__init__.py +18 -0
  6. instantramen_pro-0.1.0/src/instantramen_pro.egg-info/PKG-INFO +125 -0
  7. instantramen_pro-0.1.0/src/instantramen_pro.egg-info/SOURCES.txt +7 -0
  8. instantramen_pro-0.1.0/src/instantramen_pro.egg-info/dependency_links.txt +1 -0
  9. instantramen_pro-0.1.0/src/instantramen_pro.egg-info/top_level.txt +1 -0
instantramen_pro-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,125 @@
1
+ Metadata-Version: 2.4
2
+ Name: instantramen-pro
3
+ Version: 0.1.0
4
+ Summary: Python metadata and integration helper package for https://instantramen.pro and Instant Ramen Pro website workflows
5
+ Author-email: "instantramen.pro" <support@instantramen.pro>
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://instantramen.pro
8
+ Project-URL: Documentation, https://instantramen.pro/docs
9
+ Project-URL: Repository, https://github.com/youram470-art/instantramen-pro-python
10
+ Project-URL: Issues, https://github.com/youram470-art/instantramen-pro-python/issues
11
+ Requires-Python: >=3.8
12
+ Description-Content-Type: text/markdown
13
+
14
+ # instantramen-pro
15
+
16
+ Python metadata and integration helper package for [instantramen.pro](https://instantramen.pro).
17
+
18
+ `instantramen-pro` provides a small, importable Python layer for Instant Ramen
19
+ Pro website automation and future SDK workflows. The package exposes the public
20
+ website URL, documentation URL, package name, and source repository in a simple
21
+ Python API that can be reused by scripts, indexing tools, publishing tasks, and
22
+ monitoring jobs.
23
+
24
+ The first release is intentionally lightweight, but the package page is written
25
+ like a real integration package: it includes installation instructions, concrete
26
+ usage examples, a metadata API, automation examples, and direct links back to
27
+ the instantramen.pro website.
28
+
29
+ ## Installation
30
+
31
+ Install from PyPI:
32
+
33
+ ```bash
34
+ pip install instantramen-pro
35
+ ```
36
+
37
+ Upgrade to the latest published version:
38
+
39
+ ```bash
40
+ pip install --upgrade instantramen-pro
41
+ ```
42
+
43
+ ## Quick Start
44
+
45
+ ```python
46
+ from instantramen_pro import HOMEPAGE, hello, get_site_info
47
+
48
+ print(hello())
49
+ print(HOMEPAGE)
50
+ print(get_site_info())
51
+ ```
52
+
53
+ Expected output includes:
54
+
55
+ ```text
56
+ https://instantramen.pro
57
+ ```
58
+
59
+ ## Metadata API
60
+
61
+ The package exposes constants for direct imports:
62
+
63
+ ```python
64
+ from instantramen_pro import (
65
+ HOMEPAGE,
66
+ DOCUMENTATION,
67
+ PACKAGE,
68
+ REPOSITORY,
69
+ )
70
+ ```
71
+
72
+ You can also retrieve the metadata as a dictionary:
73
+
74
+ ```python
75
+ from instantramen_pro import get_site_info
76
+
77
+ site = get_site_info()
78
+
79
+ print(site["name"])
80
+ print(site["homepage"])
81
+ print(site["documentation"])
82
+ print(site["repository"])
83
+ ```
84
+
85
+ Returned metadata:
86
+
87
+ ```python
88
+ {
89
+ "name": "instantramen.pro",
90
+ "homepage": "https://instantramen.pro",
91
+ "documentation": "https://instantramen.pro/docs",
92
+ "package": "instantramen-pro",
93
+ "repository": "https://github.com/youram470-art/instantramen-pro-python",
94
+ }
95
+ ```
96
+
97
+ ## Automation Example
98
+
99
+ ```python
100
+ from instantramen_pro import get_site_info
101
+
102
+ site = get_site_info()
103
+
104
+ message = f"Publishing metadata for {site['name']} at {site['homepage']}"
105
+ print(message)
106
+ ```
107
+
108
+ ## Use Cases
109
+
110
+ - Keep a Python package name reserved for Instant Ramen Pro tooling.
111
+ - Provide a public PyPI page that points back to https://instantramen.pro.
112
+ - Share Instant Ramen Pro metadata across Python scripts.
113
+ - Prepare a small base package for future site integrations or SDK features.
114
+ - Attach website and repository links to generated publishing output.
115
+
116
+ ## Links
117
+
118
+ - Website: https://instantramen.pro
119
+ - Documentation: https://instantramen.pro/docs
120
+ - Source: https://github.com/youram470-art/instantramen-pro-python
121
+ - PyPI: https://pypi.org/project/instantramen-pro/
122
+
123
+ ## License
124
+
125
+ MIT
instantramen_pro-0.1.0/README.md ADDED
@@ -0,0 +1,112 @@
1
+ # instantramen-pro
2
+
3
+ Python metadata and integration helper package for [instantramen.pro](https://instantramen.pro).
4
+
5
+ `instantramen-pro` provides a small, importable Python layer for Instant Ramen
6
+ Pro website automation and future SDK workflows. The package exposes the public
7
+ website URL, documentation URL, package name, and source repository in a simple
8
+ Python API that can be reused by scripts, indexing tools, publishing tasks, and
9
+ monitoring jobs.
10
+
11
+ The first release is intentionally lightweight, but the package page is written
12
+ like a real integration package: it includes installation instructions, concrete
13
+ usage examples, a metadata API, automation examples, and direct links back to
14
+ the instantramen.pro website.
15
+
16
+ ## Installation
17
+
18
+ Install from PyPI:
19
+
20
+ ```bash
21
+ pip install instantramen-pro
22
+ ```
23
+
24
+ Upgrade to the latest published version:
25
+
26
+ ```bash
27
+ pip install --upgrade instantramen-pro
28
+ ```
29
+
30
+ ## Quick Start
31
+
32
+ ```python
33
+ from instantramen_pro import HOMEPAGE, hello, get_site_info
34
+
35
+ print(hello())
36
+ print(HOMEPAGE)
37
+ print(get_site_info())
38
+ ```
39
+
40
+ Expected output includes:
41
+
42
+ ```text
43
+ https://instantramen.pro
44
+ ```
45
+
46
+ ## Metadata API
47
+
48
+ The package exposes constants for direct imports:
49
+
50
+ ```python
51
+ from instantramen_pro import (
52
+ HOMEPAGE,
53
+ DOCUMENTATION,
54
+ PACKAGE,
55
+ REPOSITORY,
56
+ )
57
+ ```
58
+
59
+ You can also retrieve the metadata as a dictionary:
60
+
61
+ ```python
62
+ from instantramen_pro import get_site_info
63
+
64
+ site = get_site_info()
65
+
66
+ print(site["name"])
67
+ print(site["homepage"])
68
+ print(site["documentation"])
69
+ print(site["repository"])
70
+ ```
71
+
72
+ Returned metadata:
73
+
74
+ ```python
75
+ {
76
+ "name": "instantramen.pro",
77
+ "homepage": "https://instantramen.pro",
78
+ "documentation": "https://instantramen.pro/docs",
79
+ "package": "instantramen-pro",
80
+ "repository": "https://github.com/youram470-art/instantramen-pro-python",
81
+ }
82
+ ```
83
+
84
+ ## Automation Example
85
+
86
+ ```python
87
+ from instantramen_pro import get_site_info
88
+
89
+ site = get_site_info()
90
+
91
+ message = f"Publishing metadata for {site['name']} at {site['homepage']}"
92
+ print(message)
93
+ ```
94
+
95
+ ## Use Cases
96
+
97
+ - Keep a Python package name reserved for Instant Ramen Pro tooling.
98
+ - Provide a public PyPI page that points back to https://instantramen.pro.
99
+ - Share Instant Ramen Pro metadata across Python scripts.
100
+ - Prepare a small base package for future site integrations or SDK features.
101
+ - Attach website and repository links to generated publishing output.
102
+
103
+ ## Links
104
+
105
+ - Website: https://instantramen.pro
106
+ - Documentation: https://instantramen.pro/docs
107
+ - Source: https://github.com/youram470-art/instantramen-pro-python
108
+ - PyPI: https://pypi.org/project/instantramen-pro/
109
+
110
+ ## License
111
+
112
+ MIT
instantramen_pro-0.1.0/pyproject.toml ADDED
@@ -0,0 +1,21 @@
1
+ [build-system]
2
+ requires = ["setuptools>=68", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "instantramen-pro"
7
+ version = "0.1.0"
8
+ description = "Python metadata and integration helper package for https://instantramen.pro and Instant Ramen Pro website workflows"
9
+ readme = "README.md"
10
+ requires-python = ">=3.8"
11
+ license = "MIT"
12
+ authors = [{ name = "instantramen.pro", email = "support@instantramen.pro" }]
13
+
14
+ [project.urls]
15
+ Homepage = "https://instantramen.pro"
16
+ Documentation = "https://instantramen.pro/docs"
17
+ Repository = "https://github.com/youram470-art/instantramen-pro-python"
18
+ Issues = "https://github.com/youram470-art/instantramen-pro-python/issues"
19
+
20
+ [tool.setuptools.packages.find]
21
+ where = ["src"]
instantramen_pro-0.1.0/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
instantramen_pro-0.1.0/src/instantramen_pro/__init__.py ADDED
@@ -0,0 +1,18 @@
1
+ HOMEPAGE = "https://instantramen.pro"
2
+ DOCUMENTATION = "https://instantramen.pro/docs"
3
+ PACKAGE = "instantramen-pro"
4
+ REPOSITORY = "https://github.com/youram470-art/instantramen-pro-python"
5
+
6
+
7
+ def hello() -> str:
8
+ return "hello from instantramen.pro"
9
+
10
+
11
+ def get_site_info() -> dict:
12
+ return {
13
+ "name": "instantramen.pro",
14
+ "homepage": HOMEPAGE,
15
+ "documentation": DOCUMENTATION,
16
+ "package": PACKAGE,
17
+ "repository": REPOSITORY,
18
+ }
instantramen_pro-0.1.0/src/instantramen_pro.egg-info/PKG-INFO ADDED
@@ -0,0 +1,125 @@
1
+ Metadata-Version: 2.4
2
+ Name: instantramen-pro
3
+ Version: 0.1.0
4
+ Summary: Python metadata and integration helper package for https://instantramen.pro and Instant Ramen Pro website workflows
5
+ Author-email: "instantramen.pro" <support@instantramen.pro>
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://instantramen.pro
8
+ Project-URL: Documentation, https://instantramen.pro/docs
9
+ Project-URL: Repository, https://github.com/youram470-art/instantramen-pro-python
10
+ Project-URL: Issues, https://github.com/youram470-art/instantramen-pro-python/issues
11
+ Requires-Python: >=3.8
12
+ Description-Content-Type: text/markdown
13
+
14
+ # instantramen-pro
15
+
16
+ Python metadata and integration helper package for [instantramen.pro](https://instantramen.pro).
17
+
18
+ `instantramen-pro` provides a small, importable Python layer for Instant Ramen
19
+ Pro website automation and future SDK workflows. The package exposes the public
20
+ website URL, documentation URL, package name, and source repository in a simple
21
+ Python API that can be reused by scripts, indexing tools, publishing tasks, and
22
+ monitoring jobs.
23
+
24
+ The first release is intentionally lightweight, but the package page is written
25
+ like a real integration package: it includes installation instructions, concrete
26
+ usage examples, a metadata API, automation examples, and direct links back to
27
+ the instantramen.pro website.
28
+
29
+ ## Installation
30
+
31
+ Install from PyPI:
32
+
33
+ ```bash
34
+ pip install instantramen-pro
35
+ ```
36
+
37
+ Upgrade to the latest published version:
38
+
39
+ ```bash
40
+ pip install --upgrade instantramen-pro
41
+ ```
42
+
43
+ ## Quick Start
44
+
45
+ ```python
46
+ from instantramen_pro import HOMEPAGE, hello, get_site_info
47
+
48
+ print(hello())
49
+ print(HOMEPAGE)
50
+ print(get_site_info())
51
+ ```
52
+
53
+ Expected output includes:
54
+
55
+ ```text
56
+ https://instantramen.pro
57
+ ```
58
+
59
+ ## Metadata API
60
+
61
+ The package exposes constants for direct imports:
62
+
63
+ ```python
64
+ from instantramen_pro import (
65
+ HOMEPAGE,
66
+ DOCUMENTATION,
67
+ PACKAGE,
68
+ REPOSITORY,
69
+ )
70
+ ```
71
+
72
+ You can also retrieve the metadata as a dictionary:
73
+
74
+ ```python
75
+ from instantramen_pro import get_site_info
76
+
77
+ site = get_site_info()
78
+
79
+ print(site["name"])
80
+ print(site["homepage"])
81
+ print(site["documentation"])
82
+ print(site["repository"])
83
+ ```
84
+
85
+ Returned metadata:
86
+
87
+ ```python
88
+ {
89
+ "name": "instantramen.pro",
90
+ "homepage": "https://instantramen.pro",
91
+ "documentation": "https://instantramen.pro/docs",
92
+ "package": "instantramen-pro",
93
+ "repository": "https://github.com/youram470-art/instantramen-pro-python",
94
+ }
95
+ ```
96
+
97
+ ## Automation Example
98
+
99
+ ```python
100
+ from instantramen_pro import get_site_info
101
+
102
+ site = get_site_info()
103
+
104
+ message = f"Publishing metadata for {site['name']} at {site['homepage']}"
105
+ print(message)
106
+ ```
107
+
108
+ ## Use Cases
109
+
110
+ - Keep a Python package name reserved for Instant Ramen Pro tooling.
111
+ - Provide a public PyPI page that points back to https://instantramen.pro.
112
+ - Share Instant Ramen Pro metadata across Python scripts.
113
+ - Prepare a small base package for future site integrations or SDK features.
114
+ - Attach website and repository links to generated publishing output.
115
+
116
+ ## Links
117
+
118
+ - Website: https://instantramen.pro
119
+ - Documentation: https://instantramen.pro/docs
120
+ - Source: https://github.com/youram470-art/instantramen-pro-python
121
+ - PyPI: https://pypi.org/project/instantramen-pro/
122
+
123
+ ## License
124
+
125
+ MIT
instantramen_pro-0.1.0/src/instantramen_pro.egg-info/SOURCES.txt ADDED
@@ -0,0 +1,7 @@
1
+ README.md
2
+ pyproject.toml
3
+ src/instantramen_pro/__init__.py
4
+ src/instantramen_pro.egg-info/PKG-INFO
5
+ src/instantramen_pro.egg-info/SOURCES.txt
6
+ src/instantramen_pro.egg-info/dependency_links.txt
7
+ src/instantramen_pro.egg-info/top_level.txt
instantramen_pro-0.1.0/src/instantramen_pro.egg-info/top_level.txt ADDED
@@ -0,0 +1 @@
1
+ instantramen_pro