simplysocket 0.1.0__py3-none-any.whl

simplysocket-0.1.0.dist-info/METADATA

@@ -0,0 +1,68 @@
+Metadata-Version: 2.4
+Name: simplysocket
+Version: 0.1.0
+Summary: Small helpers for creating standard-library sockets
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# simplysocket
+
+`simplysocket` is a small helper for creating Python standard-library sockets
+using familiar family and protocol names. It has no runtime dependencies.
+
+## Installation
+
+```console
+python -m pip install simplysocket
+```
+
+## Usage
+
+```python
+from simplysocket import socket
+
+tcp_socket = socket.defaultSocket()
+udp_socket = socket.createSocket(socketType="UDP")
+ipv6_socket = socket.createSocket(socketFamily="ipv6")
+
+for sock in (tcp_socket, udp_socket, ipv6_socket):
+    sock.close()
+```
+
+`createSocket` supports the families `v4`, `ipv4`, `inet`, `ip4`, `v6`,
+`ipv6`, `inet6`, `ip6`, and `bluetooth`; and the types `TCP`, `UDP`, and
+`RAW`. Omitting the family or type selects IPv4 or TCP, respectively.
+Unsupported family or type names raise `ValueError`. Bluetooth raises
+`NotImplementedError` on platforms where Python does not expose Bluetooth
+sockets. Creating raw sockets may require elevated operating-system
+permissions.
+
+## Development
+
+Build and validate the distribution with:
+
+```console
+python -m pip install --upgrade build twine
+python -m unittest discover -s tests
+python -m build
+python -m twine check dist/*
+```
+
+Upload only after reviewing the built artifacts and confirming the project
+name and release metadata:
+
+```console
+python -m twine upload dist/*
+```
+
+## License
+
+Distributed under the MIT License. See [LICENSE](LICENSE).

simplysocket-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+simplysocket.py,sha256=jpEFiQNjrVN0oVh9MVVlao5wJr_Pr2d3aQIEeKNLudc,2521
+simplysocket-0.1.0.dist-info/licenses/LICENSE,sha256=uaDU83igCLWcXF_iqqQBcAwNz4zOQdNkuHo1CS3OfUs,1103
+simplysocket-0.1.0.dist-info/METADATA,sha256=97Ck-2kzTdjeNTTcCEJvKGYtGvywGS2fqjo391n9WWY,1910
+simplysocket-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+simplysocket-0.1.0.dist-info/top_level.txt,sha256=AIEngTbzMunE458RiqdBwYVGFNQCF1g9dL1759ru8lA,13
+simplysocket-0.1.0.dist-info/RECORD,,

simplysocket-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

simplysocket-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 simplysocket contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

simplysocket-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+simplysocket

simplysocket.py

@@ -0,0 +1,76 @@
+"""Small helpers for creating standard-library sockets."""
+
+import socket as _socket
+from typing import Optional
+
+__all__ = ["socket"]
+
+
+class socket:
+    """Factory for TCP, UDP, raw, IPv4, IPv6, and Bluetooth sockets."""
+
+    TCP = _socket.SOCK_STREAM
+    UDP = _socket.SOCK_DGRAM
+    RAW_SOCKET = _socket.SOCK_RAW
+
+    IPv4 = _socket.AF_INET
+    IPv6 = _socket.AF_INET6
+    BLUETOOTH = getattr(_socket, "AF_BLUETOOTH", None)
+
+    @staticmethod
+    def defaultSocket() -> _socket.socket:
+        """Create a default IPv4 TCP socket."""
+        return _socket.socket(_socket.AF_INET, _socket.SOCK_STREAM)
+
+    @classmethod
+    def createSocket(
+        cls,
+        socketFamily: Optional[str] = None,
+        socketType: Optional[str] = None,
+    ) -> _socket.socket:
+        """Create a socket for a supported family and protocol type.
+
+        Families accept ``v4``, ``ipv4``, ``inet``, ``ip4``, ``v6``,
+        ``ipv6``, ``inet6``, ``ip6``, or ``bluetooth``. Types accept
+        ``TCP``, ``UDP``, or ``RAW``. Omitting either argument selects
+        IPv4 or TCP, respectively.
+
+        Raises:
+            ValueError: If the requested family or type is not supported.
+            NotImplementedError: If Bluetooth sockets are unavailable.
+        """
+        family = socketFamily.lower() if socketFamily is not None else "v4"
+        socket_kind = socketType.upper() if socketType is not None else "TCP"
+
+        families = {
+            "v4": cls.IPv4,
+            "ipv4": cls.IPv4,
+            "inet": cls.IPv4,
+            "ip4": cls.IPv4,
+            "v6": cls.IPv6,
+            "ipv6": cls.IPv6,
+            "inet6": cls.IPv6,
+            "ip6": cls.IPv6,
+        }
+        if family in families:
+            family_id = families[family]
+        elif family == "bluetooth":
+            if cls.BLUETOOTH is None:
+                raise NotImplementedError(
+                    "Bluetooth sockets are not supported on this platform"
+                )
+            family_id = cls.BLUETOOTH
+        else:
+            raise ValueError(f"Unsupported socket family: {socketFamily!r}")
+
+        socket_types = {
+            "TCP": cls.TCP,
+            "UDP": cls.UDP,
+            "RAW": cls.RAW_SOCKET,
+        }
+        try:
+            socket_type = socket_types[socket_kind]
+        except KeyError:
+            raise ValueError(f"Unsupported socket type: {socketType!r}") from None
+
+        return _socket.socket(family_id, socket_type)