Skip to content

Commit b269acc

Browse files
VigneshVSVVigneshVSV
committed
code style formatting for rest of the files
1 parent 633d018 commit b269acc

File tree

9 files changed

+274
-41
lines changed

9 files changed

+274
-41
lines changed

‎docs/beginners-guide/code/actions/parameterized_function.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import multiprocessing
2-
from hololinked.server import Thing, action
2+
from hololinked.core import Thing, action
33
from hololinked.param import ParameterizedFunction
4-
from hololinked.server.properties import ClassSelector
4+
from hololinked.core.properties import ClassSelector
55
from hololinked.client import ObjectProxy
66
import numpy
77

‎docs/beginners-guide/code/eventloop/import.py‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
from hololinked.client import ObjectProxy
22
from hololinked.server import EventLoop
33

4-
eventloop_proxy = ObjectProxy(instance_name='eventloop', protocol="TCP",
5-
socket_address="tcp://192.168.0.10:60000") #type: EventLoop
6-
obj_id = eventloop_proxy.import_remote_object(file_name=r"D:\path\to\file\IDSCamera",
7-
object_name="UEyeCamera")
8-
eventloop_proxy.instantiate(obj_id, instance_name='camera', device_id=3)
4+
eventloop_proxy = ObjectProxy(
5+
instance_name="eventloop", protocol="TCP", socket_address="tcp://192.168.0.10:60000"
6+
) # type: EventLoop
7+
obj_id = eventloop_proxy.import_remote_object(
8+
file_name=r"D:\path\to\file\IDSCamera", object_name="UEyeCamera"
9+
)
10+
eventloop_proxy.instantiate(obj_id, instance_name="camera", device_id=3)

‎docs/beginners-guide/code/eventloop/list_of_devices.py‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,20 @@
55

66

77
def start_http_server():
8-
server = HTTPServer(remote_objects=['spectrometer', 'eventloop', 'camera'])
8+
server = HTTPServer(remote_objects=["spectrometer", "eventloop", "camera"])
99
server.start()
1010

11-
if __name__ == '__main__()':
12-
11+
12+
if __name__ == "__main__()":
1313
Process(target=start_http_server).start()
14-
15-
spectrometer = OceanOpticsSpectrometer(instance_name='spectrometer',
16-
serial_number='USB2+H15897')
17-
18-
camera = UEyeCamera(instance_name='camera', camera_id=3)
14+
15+
spectrometer = OceanOpticsSpectrometer(
16+
instance_name="spectrometer", serial_number="USB2+H15897"
17+
)
18+
19+
camera = UEyeCamera(instance_name="camera", camera_id=3)
1920

2021
EventLoop(
2122
[spectrometer, camera],
22-
instance_name='eventloop',
23-
).run()
23+
instance_name="eventloop",
24+
).run()

‎docs/beginners-guide/code/eventloop/run_eq.py‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@
55

66

77
def start_http_server():
8-
server = HTTPServer(remote_objects=['spectrometer', 'eventloop'])
8+
server = HTTPServer(remote_objects=["spectrometer", "eventloop"])
99
server.start()
1010

11-
if __name__ == '__main__()':
12-
11+
12+
if __name__ == "__main__()":
1313
Process(target=start_http_server).start()
14-
14+
1515
EventLoop(
16-
OceanOpticsSpectrometer(instance_name='spectrometer',
17-
serial_number='USB2+H15897'),
18-
instance_name='eventloop',
19-
).run()
16+
OceanOpticsSpectrometer(
17+
instance_name="spectrometer", serial_number="USB2+H15897"
18+
),
19+
instance_name="eventloop",
20+
).run()

‎docs/beginners-guide/code/zmq_client.py‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
from hololinked.client import ObjectProxy
22

3-
spectrometer_proxy = ObjectProxy(instance_name='spectrometer',
4-
serializer='msgpack', protocol='IPC')
3+
spectrometer_proxy = ObjectProxy(
4+
instance_name="spectrometer", serializer="msgpack", protocol="IPC"
5+
)
56
# setting and getting property
6-
spectrometer_proxy.serial_number = 'USB2+H15897'
7+
spectrometer_proxy.serial_number = "USB2+H15897"
78
print(spectrometer_proxy.serial_number)
89
# calling actions
910
spectrometer_proxy.connect()
@@ -15,16 +16,21 @@
1516
from hololinked.client import ObjectProxy
1617
from oceanoptics_spectrometer import OceanOpticsSpectrometer
1718

18-
spectrometer_proxy = ObjectProxy(instance_name='spectrometer', protocol='TCP',
19-
serializer='pickle',
20-
socket_address="tcp://192.168.0.100:6539") # type: OceanOpticsSpectrometer
21-
spectrometer_proxy.serial_number = 'USB2+H15897'
22-
spectrometer_proxy.connect() # provides type definitions corresponding to server
19+
spectrometer_proxy = ObjectProxy(
20+
instance_name="spectrometer",
21+
protocol="TCP",
22+
serializer="pickle",
23+
socket_address="tcp://192.168.0.100:6539",
24+
) # type: OceanOpticsSpectrometer
25+
spectrometer_proxy.serial_number = "USB2+H15897"
26+
spectrometer_proxy.connect() # provides type definitions corresponding to server
27+
2328

2429
def event_cb(event_data):
2530
print(event_data)
2631

27-
spectrometer_proxy.subscribe_event(name='intensity-measurement', callbacks=event_cb)
32+
33+
spectrometer_proxy.subscribe_event(name="intensity-measurement", callbacks=event_cb)
2834
spectrometer_proxy.start_acquisition()
29-
# name can be the value for name given to the event in the server side or the
35+
# name can be the value for name given to the event in the server side or the
3036
# python attribute where the Event was assigned.

‎docs/introduction/license.md‎

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
```
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
Copyright 2025 Vignesh Venkatasubramanian Vaidyanathan
180+
181+
Licensed under the Apache License, Version 2.0 (the "License");
182+
you may not use this file except in compliance with the License.
183+
You may obtain a copy of the License at
184+
185+
http://www.apache.org/licenses/LICENSE-2.0
186+
187+
Unless required by applicable law or agreed to in writing, software
188+
distributed under the License is distributed on an "AS IS" BASIS,
189+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190+
See the License for the specific language governing permissions and
191+
limitations under the License.
192+
193+
APPENDIX: How to apply the Apache License to your work.
194+
195+
To apply the Apache License to your work, attach the following
196+
boilerplate notice, with the fields enclosed by brackets "[]"
197+
replaced with your own identifying information. (Don't include
198+
the brackets!) The text should be enclosed in the appropriate
199+
comment syntax for the file format. We also recommend that a
200+
file or class name and description of purpose be included on the
201+
same "printed page" as the copyright notice for easier
202+
identification within third-party archives.
203+
204+
Copyright [yyyy] [name of copyright owner]
205+
```

‎docs/stylesheets/extra.css‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@
1616
display: none;
1717
}
1818

19-
/* @media (min-width: 1000px) {
20-
.md-content {
21-
min-width: 1000px;
22-
margin: 0 auto;
23-
}
24-
} */
19+
@media (min-width: 1920px) {
20+
.md-content {
21+
min-width: 1000px;
22+
margin: 0 auto;
23+
}
24+
}
2525

2626
@media screen and (min-width: 76.25em) and (max-width: 120rem) {
2727
.md-sidebar--primary {

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ nav:
1111
- Installation: introduction/installation.md
1212
- Resources: introduction/resources.md
1313
- Contributing: introduction/contributing.md
14+
- License: introduction/license.md
1415
# textbook like how-to tutorials
1516
- Beginner's Guide:
1617
- Expose Python Objects: beginners-guide/articles/servers.md

‎pyproject.toml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,20 @@ dependencies = [
1818

1919
[tool.uv.sources]
2020
hololinked = { git = "https://github.com/hololinked-dev/hololinked.git", branch = "main" }
21+
22+
[dependency-groups]
23+
dev = [
24+
"ConfigParser==7.1.0",
25+
"fastjsonschema==2.20.0",
26+
"ipython==8.12.3",
27+
"serpent==1.41",
28+
"numpy>=2.0.0",
29+
"pip>=25.2",
30+
"pandas==2.2.3",
31+
"faker==37.5.0",
32+
"bcrypt==4.3.0",
33+
"ruff>=0.12.10",
34+
"jupyter>=1.1.1",
35+
"requests==2.32.3",
36+
"imageio"
37+
]

0 commit comments

Comments
 (0)