Code Monkey home page Code Monkey logo

crypto_finder's Introduction

crypto_finder

code style: black

What Where
Documentation http://localhost:8899/docs
Maintainer nordzisko

Crypto Finder aiohttp application

Application that connects to exchanges thru ccxt library and obtain prices from cryptocurrency exchange.

Default exchange used in this project is kucoin. Base currency is USDT. Both these values can be changed in docker-compose.yml file or in settings.py as default value.

Docs to this API is accessible on URL http://localhost:8899/docs and is done with Swagger.

Usage

Install and run:

docker-compose up

Application is exposed on port 8899 and has two endpoints:

  • GET /price/{currency}
  • GET /price/history?page={page}

Postgres database is exposed on port 5432 and credentials if needed could be found in config/default.conf file. I would strongly suggest storing passwords in some tools for secrets such as Vault, but it is out of the scope of this project.

Tests

To run tests:

docker-compose -f docker-compose.test.yml up

Code formatting

Code formatting is done by Black formatter to format the Python files.

Pre-commit hooks

Set of pre-commit hooks to apply Black, check YAML and Markdown files, etc. is provided. You can install pre-commit with pip or brew. Then you can install hooks itself with command: pre-commit install --install-hooks in your repo folder.

crypto_finder's People

Stargazers

WebClinic 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.