"The Dog Breed for You" Python Client Application README
RUNNING THE SERVER FILE:
Create a Putty SSH connection with:
Hostname: cs2s.yorkdc.net
Port: 2222
Will be promted for Username & Password:
Username: charley.punshon
Password: AMG58FXU
Relocate to the htdocs folder in the terminal, type the following command:
cd htdocs
Run the server file, type the following command:
python server.py
---------------------------USING THE PYTHON CLIENT---------------------------
PREREQUISITES:
Install python 3.9 on machine:
https://www.python.org/downloads/
or from Windows app store
Download pythonclient file https://git.yorkdc.net:8888/charley.punshon/pythonclient (extract file if needed to).
To run the application open Command Line and run the following commands (this virtual environment was created on a Windows machine):
cd <path of pythonclient file>
.\venv\Scripts\activate (after this you should be in the virtual environment)
pip install urllib3
python main.py
To leave the virtual environment once you are finished with the application, run the following command:
deactivate
USING THE APPLICATION:
LOGGING IN:
Username: dogs
Password: AreTheBest
Once the login button is pressed this uses a post method to query an SQL table called dogsLogin for the application credentials
If the credentials are correct the main menu of the client application will appear.
If the credentials are incorrect the client will alert the user by saying "Login unsuccessful try again".
A user has to login to access the main menu of the application.
DOG BREED INFORMATION (GET method):
When the Dog Breeds button is pressed it will return all dog breeds within the SQL dogs table.
The information for each dog is printed within a Tkinter canvas.
If the server was unable to return the dogs the user will be alerted by saying "Unable to get dog breeds please try again".
ADD/UPDATE A DOG BREED TO DATABASE (POST method):
To add a dog breed to the database the user must select the "Add Dog Breed" button from the main menu and then enter the appropriate information in the form fields and then submit.
If the dog breed that the user has entered already exists within the database the record will be updated.
If the dog breed that the user has entered does not already exist within the database the dog breed and corresponding information will be added to the database.
If the dog breed was added to the database the client will alert the user by saying "Dog Breed has been added to our database".
If the dog breed was unable to be added to the database the client will alert the user by saying "Dog Breed was unable to be added to our database. Please try again.".
DELETE A DOG FROM THE DATABASE (DELETE method):
The user must press the "Delete Dog Breeds" button from the main menu, this creates a Tkinter selector widget.
The user must then select from the list which dog breed they want to delete from the database and then press the submit button.
This will then delete the appropriate dog record from the dogs SQL table.
UPDATE A DOG IMAGE (PUT method):
The user must press the "Update Dog Breeds" button from the main menu, this creates a Tkinter selector widget.
The user must then select from the list which dog image that they would like to update.
Then the user must enter an image url into the text input within this form then press the submit button.
This will then update the appropriate dog record from the dogs SQL table.
LOGGING OUT:
To logout of the application click the logout button underneath the application header in the top Tkinter canvas - this will redirect to the login view for the client.
