- add address of the location to addressbook.
- view all the locations that you have added.
- get specific location address.
- delete the existing location address.
- update the location address.
- find the available location addresses from the book within the given distance :)
step1:
create directory mkdir <directory-name>
step2: (optional)
create virtual environment:
for mac pip3 install virtualenv
for linux and windows pip install virtualenv
refer link https://www.geeksforgeeks.org/creating-python-virtual-environment-windows-linux/
create virtual environment
virtualenv <virtualenv-name>
activate virtual environment
source <virtualenv-name>/bin/activate
step3:
clone the repo using command git clone https://github.com/shashank-k-y/addressbook.git
step4: Install dependencies:
in terminal:
cd addressbook
pip install -r requirements.txt
for mac use pip3 install -r requirements.txt
step5:
Run Local server:
using command uvicorn address_book.main:app --reload
server starts like below ->
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO: Started reloader process [45935] using statreload
INFO: Started server process [45937]
INFO: Waiting for application startup.
INFO: Application startup complete.
^CINFO: Shutting down
INFO: Waiting for application shutdown.
INFO: Application shutdown complete.
INFO: Finished server process [45937]
INFO: Stopping reloader process [45935]
step6:
open http://127.0.0.1:8000/docs in browser it will display something like ->
addressbook is now ready to use :) cheers!!