LinkInCell 0.0.1__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.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,105 @@
1
+ Metadata-Version: 2.1
2
+ Name: LinkInCell
3
+ Version: 0.0.1
4
+ Summary: A small python package
5
+ Home-page: https://github.com/readwanur19/LinkInCell
6
+ Author: readwanur19
7
+ Author-email: rrumon710@gmail.com
8
+ License: Apache
9
+ Project-URL: Bug Tracker, https://github.com/readwanur19/LinkInCell/issues
10
+ Classifier: Programming Language :: Python :: 3.8
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Classifier: Operating System :: OS Independent
13
+ License-File: LICENSE
14
+ Requires-Dist: ensure==1.0.2
15
+ Requires-Dist: py-youtube==1.1.7
16
+ Provides-Extra: testing
17
+ Requires-Dist: pytest>=7.1.3; extra == "testing"
18
+ Requires-Dist: mypy>=0.971; extra == "testing"
19
+ Requires-Dist: flake8>=5.0.4; extra == "testing"
20
+ Requires-Dist: tox>=3.25.1; extra == "testing"
21
+
22
+ # LinkInCell 🔗
23
+
24
+ [![PyPI version](https://badge.fury.io/py/LinkInCell.svg)](https://badge.fury.io/py/LinkInCell)
25
+ [![Python Versions](https://img.shields.io/pypi/pyversions/LinkInCell.svg)](https://pypi.org/project/LinkInCell/)
26
+ [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
27
+
28
+ **LinkInCell** is a lightweight PyPI package that brings the web to your Jupyter environment. It allows you to seamlessly render fully interactive websites and embedded YouTube videos directly inside your `.ipynb` notebook cells.
29
+
30
+ ---
31
+
32
+ ## ✨ Features
33
+
34
+ * **Render Any Website:** Display live, interactive web pages within an iframe in your notebook.
35
+ * **YouTube Integration:** Native support for embedding and playing YouTube videos without leaving your workflow.
36
+ * **Lightweight & Fast:** Minimal dependencies, designed specifically for Jupyter environments.
37
+ * **Customizable:** Adjust the width and height of the rendering area to fit your screen perfectly.
38
+
39
+ ## 📦 Installation
40
+
41
+ You can install `LinkInCell` directly from PyPI using pip:
42
+
43
+ ```bash
44
+ pip install LinkInCell
45
+ ```
46
+
47
+ # How to install this package in your system
48
+
49
+ ```bash
50
+ conda create -n LinkInCell_env python=3.8 -y
51
+ ```
52
+
53
+ ```bash
54
+ conda activate LinkInCell_env
55
+ ```
56
+
57
+ ```bash
58
+ pip install -r requirements_dev.txt
59
+ ```
60
+
61
+
62
+ ## 🚀 Usage
63
+
64
+ Using `LinkInCell` is incredibly simple. Import the package and pass your target URL.
65
+
66
+ ### 1. Rendering a Website
67
+
68
+ python
69
+ from linkincell import render_web
70
+
71
+ # Render a full webpage inside your notebook cell
72
+ render_web("https://en.wikipedia.org/wiki/Python_(programming_language)", width="100%", height="500px")
73
+
74
+
75
+ ### 2. Rendering a YouTube Video
76
+
77
+ python
78
+ from linkincell import render_youtube
79
+
80
+ # Pass the standard YouTube URL or the video ID
81
+ render_youtube("https://www.youtube.com/watch?v=dQw4w9WgXcQ", width=800, height=450)
82
+
83
+
84
+ ## 🛠️ Requirements
85
+
86
+ * Python 3.6+
87
+ * Jupyter Notebook or JupyterLab
88
+ * `IPython` (Usually comes pre-installed with Jupyter)
89
+
90
+ ## 🤝 Contributing
91
+
92
+ Contributions, issues, and feature requests are welcome! Since open-source collaboration thrives on shared knowledge, feel free to check the [issues page](#) if you want to contribute.
93
+
94
+ 1. Fork the Project
95
+ 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
96
+ 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
97
+ 4. Push to the Branch (`git push origin feature/AmazingFeature`)
98
+ 5. Open a Pull Request
99
+
100
+ ## 📄 License
101
+
102
+ Distributed under the Apache License 2.0. See `LICENSE` for more information.
103
+
104
+ ---
105
+ *Built for the community, by the community.*
@@ -0,0 +1,84 @@
1
+ # LinkInCell 🔗
2
+
3
+ [![PyPI version](https://badge.fury.io/py/LinkInCell.svg)](https://badge.fury.io/py/LinkInCell)
4
+ [![Python Versions](https://img.shields.io/pypi/pyversions/LinkInCell.svg)](https://pypi.org/project/LinkInCell/)
5
+ [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
6
+
7
+ **LinkInCell** is a lightweight PyPI package that brings the web to your Jupyter environment. It allows you to seamlessly render fully interactive websites and embedded YouTube videos directly inside your `.ipynb` notebook cells.
8
+
9
+ ---
10
+
11
+ ## ✨ Features
12
+
13
+ * **Render Any Website:** Display live, interactive web pages within an iframe in your notebook.
14
+ * **YouTube Integration:** Native support for embedding and playing YouTube videos without leaving your workflow.
15
+ * **Lightweight & Fast:** Minimal dependencies, designed specifically for Jupyter environments.
16
+ * **Customizable:** Adjust the width and height of the rendering area to fit your screen perfectly.
17
+
18
+ ## 📦 Installation
19
+
20
+ You can install `LinkInCell` directly from PyPI using pip:
21
+
22
+ ```bash
23
+ pip install LinkInCell
24
+ ```
25
+
26
+ # How to install this package in your system
27
+
28
+ ```bash
29
+ conda create -n LinkInCell_env python=3.8 -y
30
+ ```
31
+
32
+ ```bash
33
+ conda activate LinkInCell_env
34
+ ```
35
+
36
+ ```bash
37
+ pip install -r requirements_dev.txt
38
+ ```
39
+
40
+
41
+ ## 🚀 Usage
42
+
43
+ Using `LinkInCell` is incredibly simple. Import the package and pass your target URL.
44
+
45
+ ### 1. Rendering a Website
46
+
47
+ python
48
+ from linkincell import render_web
49
+
50
+ # Render a full webpage inside your notebook cell
51
+ render_web("https://en.wikipedia.org/wiki/Python_(programming_language)", width="100%", height="500px")
52
+
53
+
54
+ ### 2. Rendering a YouTube Video
55
+
56
+ python
57
+ from linkincell import render_youtube
58
+
59
+ # Pass the standard YouTube URL or the video ID
60
+ render_youtube("https://www.youtube.com/watch?v=dQw4w9WgXcQ", width=800, height=450)
61
+
62
+
63
+ ## 🛠️ Requirements
64
+
65
+ * Python 3.6+
66
+ * Jupyter Notebook or JupyterLab
67
+ * `IPython` (Usually comes pre-installed with Jupyter)
68
+
69
+ ## 🤝 Contributing
70
+
71
+ Contributions, issues, and feature requests are welcome! Since open-source collaboration thrives on shared knowledge, feel free to check the [issues page](#) if you want to contribute.
72
+
73
+ 1. Fork the Project
74
+ 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
75
+ 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
76
+ 4. Push to the Branch (`git push origin feature/AmazingFeature`)
77
+ 5. Open a Pull Request
78
+
79
+ ## 📄 License
80
+
81
+ Distributed under the Apache License 2.0. See `LICENSE` for more information.
82
+
83
+ ---
84
+ *Built for the community, by the community.*
@@ -0,0 +1,12 @@
1
+ [build-system]
2
+ requires = ['setuptools>=42.0', "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [tool.pytest.ini_options]
6
+ testpaths = [
7
+ "tests"
8
+ ]
9
+
10
+ [tool.mypy]
11
+ mypy_path = "src"
12
+ ignore_missing_imports = true
@@ -0,0 +1,32 @@
1
+ [metadata]
2
+ license = Apache
3
+ license_file = LICENSE
4
+ classifiers =
5
+ Programming Language :: Python :: 3.8
6
+ Programming Language :: Python :: 3.9
7
+ Operating System :: OS Independent
8
+
9
+ [options]
10
+ install_requires =
11
+ ensure == 1.0.2
12
+ py-youtube == 1.1.7
13
+ pyhton_requires = >= 3.8
14
+
15
+ [options.extras_require]
16
+ testing =
17
+ pytest>=7.1.3
18
+ mypy>=0.971
19
+ flake8>=5.0.4
20
+ tox>=3.25.1
21
+
22
+ [options.package_data]
23
+ LinkInCell = py.typed
24
+
25
+ [flake8]
26
+ max-line-length = 160
27
+ exclude = __init__.py
28
+
29
+ [egg_info]
30
+ tag_build =
31
+ tag_date = 0
32
+
@@ -0,0 +1,28 @@
1
+ import setuptools
2
+
3
+ with open("README.md", "r", encoding="utf-8") as f:
4
+ long_description = f.read()
5
+
6
+
7
+ __version__ = "0.0.1"
8
+
9
+ REPO_NAME = "LinkInCell"
10
+ AUTHOR_USER_NAME = "readwanur19"
11
+ AUTHOR_EMAIL = "rrumon710@gmail.com"
12
+ SRC_REPO = "LinkInCell"
13
+
14
+ setuptools.setup(
15
+ name = SRC_REPO,
16
+ version=__version__,
17
+ author = AUTHOR_USER_NAME,
18
+ author_email= AUTHOR_EMAIL,
19
+ description= "A small python package",
20
+ long_description= long_description,
21
+ long_description_content = "text/markdown",
22
+ url = f"https://github.com/{AUTHOR_USER_NAME}/{REPO_NAME}",
23
+ project_urls = {
24
+ "Bug Tracker": f"https://github.com/{AUTHOR_USER_NAME}/{REPO_NAME}/issues",
25
+ },
26
+ package_dir= {"" : "src"},
27
+ packages= setuptools.find_packages(where="src")
28
+ )
File without changes
@@ -0,0 +1,5 @@
1
+ class InvalidURLException(Exception):
2
+ """Exception raised for invalid URLs."""
3
+ def __init__(self, message="The provided URL is invalid."):
4
+ self.message = message
5
+ super().__init__(self.message)
@@ -0,0 +1,19 @@
1
+ import os
2
+ import logging
3
+ import sys
4
+
5
+ logging_str = "[%(asctime)s: %(levelname)s: %(module)s]: %(message)s"
6
+ log_dir = "logs"
7
+ log_filepath = os.path.join(log_dir, "running_logs.log")
8
+ os.makedirs(log_dir, exist_ok=True)
9
+
10
+ logging.basicConfig(
11
+ level=logging.INFO,
12
+ format=logging_str,
13
+ handlers=[
14
+ logging.FileHandler(log_filepath),
15
+ logging.StreamHandler(sys.stdout)
16
+ ]
17
+ )
18
+
19
+ logger = logging.getLogger("LinkInCell")
@@ -0,0 +1,32 @@
1
+ from IPython.display import HTML, display
2
+ from LinkInCell.custom_exception import InvalidURLException
3
+ from LinkInCell.logger import logger
4
+ import re
5
+
6
+ def render_youtube(url: str, width: int = 780, height: int = 440):
7
+ try:
8
+ regex = r"(?:v=|\/)([0-9A-Za-z_-]{11}).*"
9
+ match = re.search(regex, url)
10
+
11
+ if not match:
12
+ raise InvalidURLException("Invalid YouTube URL")
13
+
14
+ video_id = match.group(1)
15
+ embed_url = f"https://www.youtube-nocookie.com/embed/{video_id}"
16
+
17
+ iframe = f"""
18
+ <iframe width="{width}" height="{height}"
19
+ src="{embed_url}"
20
+ title="YouTube video player"
21
+ frameborder="0"
22
+ allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
23
+ referrerpolicy="strict-origin-when-cross-origin"
24
+ allowfullscreen>
25
+ </iframe>
26
+ """
27
+ display(HTML(iframe))
28
+ logger.info(f"Successfully rendered YouTube video for URL: {url}.")
29
+
30
+ return "Success."
31
+ except Exception as e:
32
+ raise e
@@ -0,0 +1,105 @@
1
+ Metadata-Version: 2.1
2
+ Name: LinkInCell
3
+ Version: 0.0.1
4
+ Summary: A small python package
5
+ Home-page: https://github.com/readwanur19/LinkInCell
6
+ Author: readwanur19
7
+ Author-email: rrumon710@gmail.com
8
+ License: Apache
9
+ Project-URL: Bug Tracker, https://github.com/readwanur19/LinkInCell/issues
10
+ Classifier: Programming Language :: Python :: 3.8
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Classifier: Operating System :: OS Independent
13
+ License-File: LICENSE
14
+ Requires-Dist: ensure==1.0.2
15
+ Requires-Dist: py-youtube==1.1.7
16
+ Provides-Extra: testing
17
+ Requires-Dist: pytest>=7.1.3; extra == "testing"
18
+ Requires-Dist: mypy>=0.971; extra == "testing"
19
+ Requires-Dist: flake8>=5.0.4; extra == "testing"
20
+ Requires-Dist: tox>=3.25.1; extra == "testing"
21
+
22
+ # LinkInCell 🔗
23
+
24
+ [![PyPI version](https://badge.fury.io/py/LinkInCell.svg)](https://badge.fury.io/py/LinkInCell)
25
+ [![Python Versions](https://img.shields.io/pypi/pyversions/LinkInCell.svg)](https://pypi.org/project/LinkInCell/)
26
+ [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
27
+
28
+ **LinkInCell** is a lightweight PyPI package that brings the web to your Jupyter environment. It allows you to seamlessly render fully interactive websites and embedded YouTube videos directly inside your `.ipynb` notebook cells.
29
+
30
+ ---
31
+
32
+ ## ✨ Features
33
+
34
+ * **Render Any Website:** Display live, interactive web pages within an iframe in your notebook.
35
+ * **YouTube Integration:** Native support for embedding and playing YouTube videos without leaving your workflow.
36
+ * **Lightweight & Fast:** Minimal dependencies, designed specifically for Jupyter environments.
37
+ * **Customizable:** Adjust the width and height of the rendering area to fit your screen perfectly.
38
+
39
+ ## 📦 Installation
40
+
41
+ You can install `LinkInCell` directly from PyPI using pip:
42
+
43
+ ```bash
44
+ pip install LinkInCell
45
+ ```
46
+
47
+ # How to install this package in your system
48
+
49
+ ```bash
50
+ conda create -n LinkInCell_env python=3.8 -y
51
+ ```
52
+
53
+ ```bash
54
+ conda activate LinkInCell_env
55
+ ```
56
+
57
+ ```bash
58
+ pip install -r requirements_dev.txt
59
+ ```
60
+
61
+
62
+ ## 🚀 Usage
63
+
64
+ Using `LinkInCell` is incredibly simple. Import the package and pass your target URL.
65
+
66
+ ### 1. Rendering a Website
67
+
68
+ python
69
+ from linkincell import render_web
70
+
71
+ # Render a full webpage inside your notebook cell
72
+ render_web("https://en.wikipedia.org/wiki/Python_(programming_language)", width="100%", height="500px")
73
+
74
+
75
+ ### 2. Rendering a YouTube Video
76
+
77
+ python
78
+ from linkincell import render_youtube
79
+
80
+ # Pass the standard YouTube URL or the video ID
81
+ render_youtube("https://www.youtube.com/watch?v=dQw4w9WgXcQ", width=800, height=450)
82
+
83
+
84
+ ## 🛠️ Requirements
85
+
86
+ * Python 3.6+
87
+ * Jupyter Notebook or JupyterLab
88
+ * `IPython` (Usually comes pre-installed with Jupyter)
89
+
90
+ ## 🤝 Contributing
91
+
92
+ Contributions, issues, and feature requests are welcome! Since open-source collaboration thrives on shared knowledge, feel free to check the [issues page](#) if you want to contribute.
93
+
94
+ 1. Fork the Project
95
+ 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
96
+ 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
97
+ 4. Push to the Branch (`git push origin feature/AmazingFeature`)
98
+ 5. Open a Pull Request
99
+
100
+ ## 📄 License
101
+
102
+ Distributed under the Apache License 2.0. See `LICENSE` for more information.
103
+
104
+ ---
105
+ *Built for the community, by the community.*
@@ -0,0 +1,14 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ setup.cfg
5
+ setup.py
6
+ src/LinkInCell/__init__.py
7
+ src/LinkInCell/custom_exception.py
8
+ src/LinkInCell/logger.py
9
+ src/LinkInCell/youtube.py
10
+ src/LinkInCell.egg-info/PKG-INFO
11
+ src/LinkInCell.egg-info/SOURCES.txt
12
+ src/LinkInCell.egg-info/dependency_links.txt
13
+ src/LinkInCell.egg-info/requires.txt
14
+ src/LinkInCell.egg-info/top_level.txt
@@ -0,0 +1,8 @@
1
+ ensure==1.0.2
2
+ py-youtube==1.1.7
3
+
4
+ [testing]
5
+ pytest>=7.1.3
6
+ mypy>=0.971
7
+ flake8>=5.0.4
8
+ tox>=3.25.1
@@ -0,0 +1 @@
1
+ LinkInCell