fing-agent-api 1.0.0__tar.gz

fing_agent_api-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fing_agent_api-1.0.0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.1
+Name: fing_agent_api
+Version: 1.0.0
+Summary: Fing Agent local API library.
+Author-email: Lorenzo Gasparini <lorenzo.gasparini@lansweeper.com>
+Project-URL: Homepage, https://github.com/fingltd/fing-agent-pyapi
+Project-URL: Issues, https://github.com/fingltd/fing-agent-pyapi/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11.1
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx
+
+# Fing Agent API
+
+**FingAgent** is a Python library for interfacing with the local APIs of the Fingbox. It allows you to easily interact with the devices and contacts managed by your Fingbox.
+
+## Requirements
+
+- Python 3.11.1 or higher
+- [httpx](https://www.python-httpx.org/) (for asynchronous HTTP requests)
+
+## Example
+
+Here is a complete example of using the library:
+
+```python
+from fingagent import FingAgent
+import asyncio
+
+async def main():
+    # Configure the Fing agent
+    agent = FingAgent(ip='your_agent_ip', port=49090, key='your_api_key')
+    
+    # Get and print devices
+    devices = await agent.get_devices()
+    print("Devices:", devices)
+    
+    # Get and print contacts
+    contacts = await agent.get_contacts()
+    print("Contacts:", contacts)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```

fing_agent_api-1.0.0/README.md

@@ -0,0 +1,32 @@
+# Fing Agent API
+
+**FingAgent** is a Python library for interfacing with the local APIs of the Fingbox. It allows you to easily interact with the devices and contacts managed by your Fingbox.
+
+## Requirements
+
+- Python 3.11.1 or higher
+- [httpx](https://www.python-httpx.org/) (for asynchronous HTTP requests)
+
+## Example
+
+Here is a complete example of using the library:
+
+```python
+from fingagent import FingAgent
+import asyncio
+
+async def main():
+    # Configure the Fing agent
+    agent = FingAgent(ip='your_agent_ip', port=49090, key='your_api_key')
+    
+    # Get and print devices
+    devices = await agent.get_devices()
+    print("Devices:", devices)
+    
+    # Get and print contacts
+    contacts = await agent.get_contacts()
+    print("Contacts:", contacts)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```

fing_agent_api-1.0.0/fing_agent_api/__init__.py

@@ -0,0 +1,4 @@
+"""Fing Agent API library module."""
+
+from .fing_agent_api import FingAgent
+from . import models

fing_agent_api-1.0.0/fing_agent_api/fing_agent_api.py

@@ -0,0 +1,28 @@
+"""Fing Agent API library."""
+
+import httpx
+from .models import ContactResponse, DeviceResponse
+
+
+class FingAgent:
+    """Fing Agent API class."""
+
+    def __init__(self, ip: str, port: int, key: str) -> None:
+        """Initialize Fing API object."""
+        self._host = f"http://{ip}:{port}/1"
+        self._key = key
+
+    async def get_devices(self, timeout: float = 120) -> DeviceResponse:
+        """Return devices discovered by Fing."""
+        url = f"{self._host}/devices?auth={self._key}"
+        async with httpx.AsyncClient() as client:
+            response = await client.get(url, timeout=timeout)
+        return DeviceResponse(response.raise_for_status().json())
+
+    async def get_contacts(self, timeout: float = 120) -> ContactResponse:
+        """Return information about Fing contacts."""
+        url = f"{self._host}/people?auth={self._key}"
+        async with httpx.AsyncClient() as client:
+            response = await client.get(url, timeout=timeout)
+        return ContactResponse(response.raise_for_status().json())
+

fing_agent_api-1.0.0/fing_agent_api/models/__init__.py

@@ -0,0 +1,6 @@
+from .contact import Contact
+from .contact_info import ContactInfo
+from .contact_response import ContactResponse
+
+from .device import Device
+from .device_response import DeviceResponse

fing_agent_api-1.0.0/fing_agent_api/models/contact.py

@@ -0,0 +1,37 @@
+from typing import Any
+from .contact_info import ContactInfo
+
+class Contact:
+    """Class representing a Fing contact."""
+
+    def __init__(self, json: dict[str, Any]) -> None:
+        """Initialize Contact."""
+        self._contact_json = json
+
+    @property
+    def state_change_time(self) -> str:
+        """Return state change time."""
+        return str(self._contact_json.get("stateChangeTime"))
+
+    @property
+    def contact_info(self) -> ContactInfo:
+        """Return contact info."""
+        return ContactInfo(json=self._contact_json["contactInfo"])
+
+    @property
+    def current_state(self) -> str | None:
+        """Return current state."""
+        return (
+            str(self._contact_json.get("currentState"))
+            if self._contact_json.get("currentState") is not None
+            else None
+        )
+
+    @property
+    def presence_device_details(self) -> str | None:
+        """Return presence device details."""
+        return (
+            str(self._contact_json.get("presenceDeviceDetails"))
+            if self._contact_json.get("presenceDeviceDetails") is not None
+            else None
+        )

fing_agent_api-1.0.0/fing_agent_api/models/contact_info.py

@@ -0,0 +1,42 @@
+from typing import Any
+
+class ContactInfo:
+    """Class representing contact's information."""
+
+    def __init__(self, json: dict[str, Any]) -> None:
+        """Initialize ContactInfo."""
+        self._contact_info_json = json
+
+    @property
+    def contact_id(self) -> str:
+        """Return contact ID."""
+        return str(self._contact_info_json.get("contactId"))
+
+    @property
+    def display_name(self) -> str:
+        """Return name."""
+        return str(self._contact_info_json.get("displayName"))
+
+    @property
+    def contact_type(self) -> str:
+        """Return type."""
+        return str(self._contact_info_json.get("contactType"))
+
+    @property
+    def picture_image_data(self) -> str | None:
+        """Return image (Base64 encoded)."""
+        return (
+            str(self._contact_info_json.get("pictureImageData"))
+            if self._contact_info_json.get("pictureImageData") is not None
+            else None
+        )
+
+    @property
+    def picture_url(self) -> str | None:
+        """Return picture url."""
+        return (
+            str(self._contact_info_json.get("pictureUrl"))
+            if self._contact_info_json.get("pictureUrl") is not None
+            else None
+        )
+

fing_agent_api-1.0.0/fing_agent_api/models/contact_response.py

@@ -0,0 +1,26 @@
+from typing import Any
+from .contact import Contact
+
+class ContactResponse:
+    """Class representing the People response data."""
+
+    def __init__(self, json: dict[str, Any]) -> None:
+        """Initialize the People response object."""
+        self._network_id = str(json["networkId"])
+        self._last_change_time = str(json["lastChangeTime"])
+        self._contacts = [Contact(contact_json) for contact_json in json["people"]]
+
+    @property
+    def network_id(self) -> str:
+        """Return network ID."""
+        return self._network_id
+
+    @property
+    def last_change_time(self) -> str:
+        """Return the last change time."""
+        return self._last_change_time
+
+    @property
+    def contacts(self) -> list[Contact]:
+        """Return Fing's contacts."""
+        return self._contacts

fing_agent_api-1.0.0/fing_agent_api/models/device.py

@@ -0,0 +1,86 @@
+from typing import Any
+
+class Device:
+    """Class representing a device found by Fing."""
+
+    def __init__(self, json: dict[str, Any]) -> None:
+        """Initialize Device."""
+        self._device_json = json
+
+    @property
+    def mac(self) -> str:
+        """Return mac address."""
+        return str(self._device_json["mac"])
+
+    @property
+    def ip(self) -> list[str]:
+        """Return ip address."""
+        return list[str](self._device_json["ip"])
+
+    @property
+    def active(self) -> bool:
+        """Return state."""
+        return self._device_json["state"] == "UP"
+
+    @property
+    def name(self) -> str | None:
+        """Return name."""
+        return (
+            str(self._device_json.get("name"))
+            if self._device_json.get("name") is not None
+            else None
+        )
+
+    @property
+    def type(self) -> str | None:
+        """Return device type."""
+        return (
+            str(self._device_json.get("type"))
+            if self._device_json.get("type") is not None
+            else None
+        )
+
+    @property
+    def make(self) -> str | None:
+        """Return device maker."""
+        return (
+            str(self._device_json.get("make"))
+            if self._device_json.get("make") is not None
+            else None
+        )
+
+    @property
+    def model(self) -> str | None:
+        """Return device model."""
+        return (
+            str(self._device_json.get("model"))
+            if self._device_json.get("model") is not None
+            else None
+        )
+
+    @property
+    def contactId(self) -> str | None:
+        """Return contactId."""
+        return (
+            str(self._device_json.get("contactId"))
+            if self._device_json.get("contactId") is not None
+            else None
+        )
+
+    @property
+    def first_seen(self) -> str | None:
+        """Return first seen date-time."""
+        return (
+            str(self._device_json.get("first_seen"))
+            if self._device_json.get("first_seen") is not None
+            else None
+        )
+
+    @property
+    def last_changed(self) -> str | None:
+        """Return last changed date-time."""
+        return (
+            str(self._device_json.get("last_changed"))
+            if self._device_json.get("last_changed") is not None
+            else None
+        )

fing_agent_api-1.0.0/fing_agent_api/models/device_response.py

@@ -0,0 +1,20 @@
+from typing import Any
+from .device import Device
+
+class DeviceResponse:
+    """Class representing the Device response data."""
+
+    def __init__(self, json: dict[str, Any]) -> None:
+        """Initialize the Device response object."""
+        self._network_id = str(json.get("networkId"))
+        self._devices = [Device(device_json) for device_json in json["devices"]]
+
+    @property
+    def network_id(self) -> str | None:
+        """Return network ID."""
+        return self._network_id
+
+    @property
+    def devices(self) -> list[Device]:
+        """Return all the device found by Fing."""
+        return self._devices

fing_agent_api-1.0.0/fing_agent_api.egg-info/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.1
+Name: fing_agent_api
+Version: 1.0.0
+Summary: Fing Agent local API library.
+Author-email: Lorenzo Gasparini <lorenzo.gasparini@lansweeper.com>
+Project-URL: Homepage, https://github.com/fingltd/fing-agent-pyapi
+Project-URL: Issues, https://github.com/fingltd/fing-agent-pyapi/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11.1
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx
+
+# Fing Agent API
+
+**FingAgent** is a Python library for interfacing with the local APIs of the Fingbox. It allows you to easily interact with the devices and contacts managed by your Fingbox.
+
+## Requirements
+
+- Python 3.11.1 or higher
+- [httpx](https://www.python-httpx.org/) (for asynchronous HTTP requests)
+
+## Example
+
+Here is a complete example of using the library:
+
+```python
+from fingagent import FingAgent
+import asyncio
+
+async def main():
+    # Configure the Fing agent
+    agent = FingAgent(ip='your_agent_ip', port=49090, key='your_api_key')
+    
+    # Get and print devices
+    devices = await agent.get_devices()
+    print("Devices:", devices)
+    
+    # Get and print contacts
+    contacts = await agent.get_contacts()
+    print("Contacts:", contacts)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```

fing_agent_api-1.0.0/fing_agent_api.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+pyproject.toml
+fing_agent_api/__init__.py
+fing_agent_api/fing_agent_api.py
+fing_agent_api.egg-info/PKG-INFO
+fing_agent_api.egg-info/SOURCES.txt
+fing_agent_api.egg-info/dependency_links.txt
+fing_agent_api.egg-info/requires.txt
+fing_agent_api.egg-info/top_level.txt
+fing_agent_api/models/__init__.py
+fing_agent_api/models/contact.py
+fing_agent_api/models/contact_info.py
+fing_agent_api/models/contact_response.py
+fing_agent_api/models/device.py
+fing_agent_api/models/device_response.py

fing_agent_api-1.0.0/fing_agent_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fing_agent_api-1.0.0/fing_agent_api.egg-info/requires.txt

@@ -0,0 +1 @@
+httpx

fing_agent_api-1.0.0/fing_agent_api.egg-info/top_level.txt

@@ -0,0 +1 @@
+fing_agent_api

fing_agent_api-1.0.0/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fing_agent_api"
+version = "1.0.0"
+authors = [
+  { name="Lorenzo Gasparini", email="lorenzo.gasparini@lansweeper.com" },
+]
+description = "Fing Agent local API library."
+readme = "README.md"
+requires-python = ">=3.11.1"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+]
+dependencies = ["httpx"]
+
+[project.urls]
+Homepage = "https://github.com/fingltd/fing-agent-pyapi"
+Issues = "https://github.com/fingltd/fing-agent-pyapi/issues"

fing_agent_api-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+