Skip to content

Commit

Permalink
update to 0.0.6
Browse files Browse the repository at this point in the history
  • Loading branch information
cjerrington committed May 12, 2020
1 parent a3a6471 commit 917ea06
Show file tree
Hide file tree
Showing 5 changed files with 90 additions and 60 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
build/
dist/
netutils.egg-info
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# netutils

python module to check the status of ports for local and websites.
Python module to check the status of ports for local and websites.

# Install
pip install netutils

# Usage
```python
import netutils
google = netutils.PortCheck("google.com", 443)
google.isOpen()
```

For extra help I've added in variables to find the hostname and local IP address.
- To get hostname: netutils.host_name
- To get Local IP: netutils.host_ip
71 changes: 71 additions & 0 deletions netutils/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1,72 @@
import socket, time


__all__ = ['netutils']
__version__ = "0.0.6"
__author__ = "Clayton Errington"


class PortCheck:
def __init__(self, domain, port):
self.domain = domain
self.port = port
self.retry = 1
self.delay = 5
self.timeout = 3


def __call__(self, domain, port):
self.domain = domain
self.port = port


def checkOpen(self):
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.settimeout(self.timeout)
try:
s.connect((self.domain, int(self.port)))
s.shutdown(socket.SHUT_RDWR)
s.close()
return True
except:
return False
finally:
s.close()


def checkHost(self):
ipup = False
for i in range(self.retry):
if self.checkOpen():
ipup = True
break
else:
time.sleep(self.delay)
return ipup


def isOpen(self):
if self.checkHost():
# If connects, then we are true
return True
else:
# If connection fails, we are false
return False


def domain(self):
# Allow for domain to be returned
return self.domain


def port(self):
# Allow for port to be returned
return self.port


# return variables for use
host_name = socket.gethostname()
host_ip = socket.gethostbyname(host_name)
isOpen = PortCheck.isOpen
domain = PortCheck.domain
port = PortCheck.port
58 changes: 0 additions & 58 deletions netutils/netutils.py

This file was deleted.

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setuptools.setup(
name="netutils",
version="0.0.4",
version="0.0.6",
author="Clayton Errington",
author_email="[email protected]",
description="Simplified way to get networking port status",
Expand Down

0 comments on commit 917ea06

Please sign in to comment.