Code Monkey home page Code Monkey logo

daryllukas / luse_graph Goto Github PK

View Code? Open in Web Editor NEW

This project forked from malumbo21/lisa_graph

1.0 0.0 0.0 548 KB

Lisa Graph: A Django-based GraphQL API for querying Lusaka Stock Exchange data. Built with Python, PostgreSQL, and JWT tokens for security. Precise, efficient, and easy integration. Explore financial insights effortlessly.

Home Page: https://lisagraph.vercel.app

License: GNU General Public License v3.0

Shell 0.34% Python 99.28% Makefile 0.38%

luse_graph's Introduction

Lisa Graph API Documentation

LISA GRAPH
Lisa Graph, a robust Django-powered GraphQL API, facilitates seamless querying of Lusaka Stock Exchange data. The API offers a single query with optional filters (start, end, single_date, date) that fetches data in descending order by default.

Getting Started

  1. Installation: 
    git clone https://github.com/suwilanji-chipofya-hadat/lisa_graph
cd lisa_graph
pip install -r requirements.txt
make init # runs initial migrations (you can run individual commands in the makefile if you don't have make command available)
make run # or
python manage.py runserver

NOTE: CHANGE THE DATABASE CONFIGURATIONS IN THE settings.py file

WILL SOON PROVIDE ACCESS TO A PUBLIC DEVELOPMENT DATABASE

Query

Retrieve Data

query {
  stockData(start: "2022-01-01", end: "2022-12-31", single_date: true, date: "2022-06-30") {
    # Fields to retrieve
    id
    name
    value
    date
  }
}
  • start (optional): Start date for data filtering.
  • end (optional): End date for data filtering.
  • single_date (optional): Boolean flag for single-date retrieval.
  • date (optional): Specific date for single-date retrieval.

IF NONE OF THE OPTIONAL PARAMETERS ARE PROVIDED THE API RETURNS ALL THE DATA

PAGINATION NOT YET SUPPORTED BUT WILL BE ADDED IN NO TIME

Work Done

  • ✔️ Implemented single GraphQL query.
  • ✔️ Added optional date filters.
  • ✔️ Data retrieval in descending order by default.
  • ✔️ User authentication using JWT tokens.

Future Work

  • ☑️ Add support for news data from diffrent news platforms.
  • ☑️ AI finance forecasts.
  • ☑️ Blogging feature.
  • ☑️ Forums.

WOULD LOVE TO SEE YOUR PARTICIPATION IN THIS PROJECT

FORK THE REPO AND ADD YOUR UPDATES WILL REVIEW AND ADD AS SOON AS POSSIBLE

luse_graph's People

Contributors

suwilanji-chipofya-hadat avatar hadat-hq avatar

Stargazers

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