Git Product home page Git Product logo

stockify's Introduction

Stock Management API

This application, built with the PyNest framework, provides a robust suite of services for managing stock data within a financial system. It integrates PostgreSQL for database management and Redis for caching, enhancing performance by reducing repetitive database queries.

Features

  • Dynamic Stock Queries: Search and retrieve stocks based on symbols or custom criteria.
  • Stock and Officer Management: Add, update, and delete information about stocks and company officers.
  • Efficient Caching: Implement Redis caching to minimize database queries and speed up response times.
  • Background Processing: Use background tasks for non-blocking data operations.
  • Timeframe Analysis: Analyze stock price movements over selectable time periods.

Prerequisites

  • Docker and Docker Compose
  • Python 3.8 or higher
  • PostgreSQL
  • Redis

Installation

Clone the Repository

git clone https://github.com/ItayTheDar/Stockify.git
cd Stockify

Local Deployment

Install Dependencies

pip install -r requirements.txt

Run the Application

uvicorn src.app_module:http_server --host "0.0.0.0" --port 8000

Docker Deployment

docker-compose up --build

Usage

Access the API at http://localhost:8000 upon deployment. Explore API endpoints through the integrated Swagger UI or Redoc.

API Endpoints

GET /stocks: Fetch a list of stocks.

POST /stocks: Register a new stock.

PUT /stocks/:{id}: Modify details of an existing stock.

DELETE /stocks/:{id}: Erase a stock record.

Endpoints also include functions for managing company officers and detailed stock price data.

stockify's People

Contributors

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