Skip to main content

This is a API wrapper for NEPSE API.

Project description

NEPSE API Wrapper

This python module fetches the data from Nepali Stock Site and provides them in a pythonic and usable way.

About

This is a API wrapper for NEPSE API. This project was inspired from PyPi Nepse.

Documentation

There is a detailed guide in my documentation page for getting started and installing. Documentation

How to use?

You can use this by package from Nepse API PyPi

pip install nepse-api

Why use this?

How is this better than PyPi Nepse?

  • It is asynchronous.
  • Data can be taken as attributes rather than from dict.
  • Data is fetched from the API rather than scraping the site.
  • Data is cached

APIs used

The APIs that I used to create this API wrapper is:

How to use?

import asyncio
import httpx
from nepse import Client

async def main():

    # Doing this is optional you can directly
    # Initialize using `client = Client()` as well
    async with httpx.AsyncClient() as async_client:
        # Initializes the client
        client = Client(httpx_client=async_client)

        # Gets the data
        data = await client.security_client.get_company(symbol="UPPER")

        # Prints the highest price for that company today
        print(data.high_price)
    
# Run the function
loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Why are the attributes so in-costistent?

The attribues are in-consistent because the attributes are set according to the response set by the API. I tried changing it up but that would be distruptive because the comability with the API would be broken.

Documentation?

Documentation is still in progress!

Want To Contribute?

You can send a pull request or open an issue to contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nepse-api-1.0.0.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

nepse_api-1.0.0-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file nepse-api-1.0.0.tar.gz.

File metadata

  • Download URL: nepse-api-1.0.0.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.12.6-arch1-1

File hashes

Hashes for nepse-api-1.0.0.tar.gz
Algorithm Hash digest
SHA256 faf0767e361ce4f4d078afecde76f47cc3ca09d1f243ec5608bdbfb270d2d244
MD5 e86ebfd2d45905b7c5c9373ec00ce409
BLAKE2b-256 20183f7ca26be7d5e95e49af6f3450d6144717c0b7cec61a506b3a1ad0d97fbd

See more details on using hashes here.

File details

Details for the file nepse_api-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: nepse_api-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.12.6-arch1-1

File hashes

Hashes for nepse_api-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f3293eb2c19544c651063713c8e8b30fc8a629de5259a92e9fb47ab14c4009ae
MD5 965bffb07624634961a9deaa0b2388e2
BLAKE2b-256 27c9664ace791de4e38005a45acd04c8caecfb6bb97547a568a051d6856c2ad1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page