README.md

WorldSwissKnifeAPI 🇨🇭🔪

Rest API which is also a swiss knife and to which you can add all the features you want, and like many others, it's a REST API just for experimenting and laughing 🇨🇭🔪...

Contents

• Introduction,
• Presentation,
• Features,
• Project's structure,
• Project's development,
• Deployment,
  • Source code,
  • Docker
    • Requirements,
    • From DockerHub,
    • From Dockerfile
  • Heroku
  • Balena
• Conclusion
• Useful links

Introduction

Presentation

Features

Of course, other features can be added to this API. To learn how and have a manual guide, please go here...

Project's structure

Project's development

Deployment

Source code

Firstly, you need to clone the corresponding repository from GitHub, using the following command :

git clone https://github.com/Vicken-Ghoubiguian/WorldSwissKnifeAPI

Second, you must position yourself in the WorldSwissKnifeAPI directory thus generated, again using the following command :

cd WorldSwissKnifeAPI

Thirdly, you must install all of the required Python packages listed in the requirements.txt file :

pip3 install -r requirements.txt

Fourthly and lastly, you must launch the main.py file using the following command :

python3 main.py

This command is equivalent to this one below :

python main.py

It's now the time to enjoy yourself 😸...

Docker

Requirements

From DockerHub

The Docker image on Docker Hub is available just here...

First, to get started, you need to pull this Docker image through this command bellow :

docker pull wicken/worldswissknifeapi:latest

Secondly and finally, you have to run a new Docker container from this Docker image using the command bellow :

docker container run -d --name worldswissknifeapi -p 80:80 wicken/worldswissknifeapi:latest

It's done now... So enjoy yourself 😸...

From Dockerfile

First of all, you must clone the project's repo on GitHub thanks to the command bellow :

git clone https://github.com/Vicken-Ghoubiguian/WorldSwissKnifeAPI

Then, you have to position yourself in the WorldSwissKnifeAPI directory thus generated :

cd WorldSwissKnifeAPI

docker image build -t worldswissknifeapi:latest .

docker container run -d --name worldswissknifeapi -p 80:80 worldswissknifeapi:latest

NOW... Enjoy yourself 😸...

Heroku

Balena

Conclusion

Useful links

• Welcome to Flask-RESTX’s documentation! - Official documentation,
  • API Docs: inputs - Official documentation,
• Flask API Documentation using Flask-Restx (Swagger for Flask) - Medium,
• Request Parsing,
• Scaling your project - Official documentation,
• List All TimeZones in Python - PYnative,
• Python List append() - Programiz,
• pycountry 22.1.10 - pypi,
• Flagpedia.net,
• Embed country flag images over CDN (HTTP API) - Flagpedia.net,
• Python strftime() - Programiz,
• convertdate - GitHub,
• convertdate - PyPi,
• convertdate - Official documentation,
• Flagpedia.net,
• Embed country flag images over CDN (HTTP API) - Flagpedia.net,
• Python How to Download a File from a URL - codingem.com,
• Pushing and Pulling to and from Docker Hub - R Docker tutorial,
• Adding CSS styling to your website - PythonHow,
• How To Make a Web Application Using Flask in Python 3 - DigitalOcean,
• Using Emojis in HTML - w3schools,
• Using Emojis in HTML, CSS, and JavaScript - Kirupa,
• How to add Emoji's in your website, using HTML, CSS or JavaScript - DEV,
• Passing variables from Flask to JavaScript - Stack Overflow,
• How To Create Tooltips - w3schools,
• Font Awesome
  • Font Awesome - Documentation,