Git Product home page Git Product logo

encode-api's Introduction

API - encode and decode

This project is an api with the objective of creating an encode for an integer of up to 8 characters, generating a hash/code with a fixed length of 6 characters.

To create the code/hash, the conversion to decimal hex was used.

Technologies

Reasons to use hex:

https://www.youtube.com/watch?v=cVEj5p9GiBA

How to run the api project:

docker compose up web

Swagger url: http://127.0.0.1/docs

How to run the tests:

docker compose up test

How to generate a docker image:

docker build -t myimage .

docker run -d --name mycontainer -p 80:80 myimage

Swagger url: http://127.0.0.1/docs

Project structure:

ROOT
┣ 📂 src
┃ ┣ __init__.py 
┃ ┣ hash_script.py          # Dockerfile reference
┃ ┣ main.py                 # Main project
┣ 📂 test
┃ ┣ __init__.py
┃ ┣ test_main.py            # Test of the edpoints
┣ .coveragerc               # Coverage configuration
┣ Dockerfile                # Dockerfile reference
┣ README.md                 # Markdown file with project instructions.
┣ .gitignore                # Specifies intentionally untracked files to ignore
┣ requirements.txt          # Requirements files, are files containing a list of items to be installed using pip install

encode-api's People

Contributors

phmonte avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.