sviddo / btc_convertor Goto Github PK

Functionaly provided:

• subscribe (provide yout email)
• get actual BTC to UAH rate
• send emails to all users with actual rate

Service consists of 6 endpoints:

1. • (any api service such as Postman, but a browser) /api/subscribe_api is endpoint making subscription stuff done. Send POST request to it providing email: example
   • (browser only) /api/subscribe endpoint actually wrapping /api/subscribe_api one and supposed to use in browsers: example
2. • (any api service such as Postman, but a browser) /api/rate_api is endpoint calculating BTC price in UAHs and returning result. Send GET request to it: example
   • (browser only) /api/subscribe endpoint actually wrapping /api/rate one and supposed to use in browsers: example
3. • (any api service such as Postman, but a browser) /api/send_emails_api is endpoint sending actual BTC to UAH rate to all registered users. Send GET request to it: example
   • (browser only) /api/send_emails endpoint actually wrapping /api/send_emails one and supposed to use in browsers: example

   !!! All sent emails you can find in "All mail" or "Spam" folder in gmail (https://mail.google.com). They looks such

Find more info https://coxit.stoplight.io/docs/btc-to-uah-convertor/

How to run the application? Follow next steps:

git clone https://github.com/sviddo/btc_convertor.git
cd btc_convertor
docker build -t django-app . 
docker run -p 8000:80 django-app 

After that follow next links to see the functionality of service (for browsers):

1. http://127.0.0.1:8000/api/subscribe
2. http://127.0.0.1:8000/api/rate
3. http://127.0.0.1:8000/api/send_emails

or use any API service (e.g. Postman):

Endpoint collection !!! Desktop version of Postman is must to make requests to localhost

Trird-party libraries used in project:

1. Email delivery service Mailjet in role of SMTP server. Their SDK for Python: https://github.com/mailjet/mailjet-apiv3-python
2. Cryptoccurency platform CoinGecko to get actual BTC price. Their SDK for Python: https://github.com/man-c/pycoingecko