random-port 0.0.1__tar.gz

random_port-0.0.1/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (C) 2025 Fabrício Barros Cabral
+
+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 NON-INFRINGEMENT. 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.

random_port-0.0.1/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: random_port
+Version: 0.0.1
+Summary: Generate a free TCP or UDP random port
+Author-email: Fabrício Barros Cabral <fabriciofx@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/fabriciofx/random_port
+Project-URL: Bug Tracker, https://github.com/fabriciofx/random_port/issues
+Keywords: socket,tcp,udp,random,port,test
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# Random Port
+
+## Introduction
+
+Usually we need start a TCP or UDP server (mainly to use in tests) but, which
+port must be used? So, random-port is the answer. It generate a free random
+TCP or UDP port to be used for any server.
+
+## How to install
+
+Install it using `pip` command:
+
+```bash
+pip install random-port
+```
+
+in your project folder.
+
+## Usage
+
+- To a TCP random port:
+
+```python
+port = RandomTcpPort().value()
+```
+
+- To a UDP random port:
+
+```python
+port = RandomUdpPort().value()
+```
+
+## License
+
+The MIT License (MIT)
+
+Copyright (C) 2025 Fabrício Barros Cabral
+
+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 NON-INFRINGEMENT. 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.

random_port-0.0.1/README.md

@@ -0,0 +1,55 @@
+# Random Port
+
+## Introduction
+
+Usually we need start a TCP or UDP server (mainly to use in tests) but, which
+port must be used? So, random-port is the answer. It generate a free random
+TCP or UDP port to be used for any server.
+
+## How to install
+
+Install it using `pip` command:
+
+```bash
+pip install random-port
+```
+
+in your project folder.
+
+## Usage
+
+- To a TCP random port:
+
+```python
+port = RandomTcpPort().value()
+```
+
+- To a UDP random port:
+
+```python
+port = RandomUdpPort().value()
+```
+
+## License
+
+The MIT License (MIT)
+
+Copyright (C) 2025 Fabrício Barros Cabral
+
+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 NON-INFRINGEMENT. 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.

random_port-0.0.1/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "random_port"
+version = "0.0.1"
+description = "Generate a free TCP or UDP random port"
+authors = [{ name = "Fabrício Barros Cabral", email = "fabriciofx@gmail.com" }]
+readme = "README.md"
+license = "MIT"
+keywords = ["socket", "tcp", "udp", "random", "port", "test"]
+dependencies = []
+
+[project.urls]
+"Homepage" = "https://github.com/fabriciofx/random_port"
+"Bug Tracker" = "https://github.com/fabriciofx/random_port/issues"
+
+[project.optional-dependencies]
+dev = ["pytest", "ruff"]
+
+[tool.setuptools]
+packages = ["random_port"]

random_port-0.0.1/random_port/__init__.py

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2025 Fabrício Barros Cabral
+#
+# 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 NON-INFRINGEMENT. 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.

random_port-0.0.1/random_port.egg-info/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: random_port
+Version: 0.0.1
+Summary: Generate a free TCP or UDP random port
+Author-email: Fabrício Barros Cabral <fabriciofx@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/fabriciofx/random_port
+Project-URL: Bug Tracker, https://github.com/fabriciofx/random_port/issues
+Keywords: socket,tcp,udp,random,port,test
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# Random Port
+
+## Introduction
+
+Usually we need start a TCP or UDP server (mainly to use in tests) but, which
+port must be used? So, random-port is the answer. It generate a free random
+TCP or UDP port to be used for any server.
+
+## How to install
+
+Install it using `pip` command:
+
+```bash
+pip install random-port
+```
+
+in your project folder.
+
+## Usage
+
+- To a TCP random port:
+
+```python
+port = RandomTcpPort().value()
+```
+
+- To a UDP random port:
+
+```python
+port = RandomUdpPort().value()
+```
+
+## License
+
+The MIT License (MIT)
+
+Copyright (C) 2025 Fabrício Barros Cabral
+
+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 NON-INFRINGEMENT. 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.

random_port-0.0.1/random_port.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE.txt
+README.md
+pyproject.toml
+random_port/__init__.py
+random_port.egg-info/PKG-INFO
+random_port.egg-info/SOURCES.txt
+random_port.egg-info/dependency_links.txt
+random_port.egg-info/requires.txt
+random_port.egg-info/top_level.txt
+tests/test_random_port.py

random_port-0.0.1/random_port.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

random_port-0.0.1/random_port.egg-info/requires.txt

@@ -0,0 +1,4 @@
+
+[dev]
+pytest
+ruff

random_port-0.0.1/random_port.egg-info/top_level.txt

@@ -0,0 +1 @@
+random_port

random_port-0.0.1/setup.cfg

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

random_port-0.0.1/tests/test_random_port.py

@@ -0,0 +1,64 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2025 Fabrício Barros Cabral
+#
+# 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 NON-INFRINGEMENT. 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.
+import socket
+
+from random_port import TcpRandomPort, UdpRandomPort
+
+
+def test_tcp_random_port() -> None:
+    begin = 1024
+    end = 65535
+    port = TcpRandomPort().value()
+    assert port >= begin
+    assert port <= end
+
+
+def test_udp_random_port() -> None:
+    begin = 1024
+    end = 65535
+    port = UdpRandomPort().value()
+    assert port >= begin
+    assert port <= end
+
+
+def test_tcp_in_use() -> None:
+    host = "127.0.0.1"
+    begin = 12344
+    end = 12345
+    server = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    server.setblocking(False)
+    server.bind((host, begin))
+    free_port = TcpRandomPort(host, begin, end).value()
+    assert free_port == end
+    server.close()
+
+
+def test_udp_in_use() -> None:
+    host = "127.0.0.1"
+    begin = 12344
+    end = 12345
+    server = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    server.setblocking(False)
+    server.bind((host, begin))
+    free_port = UdpRandomPort(host, begin, end).value()
+    assert free_port == end
+    server.close()