Introduction

This is the documentation for nepse-api, a library for Python to aid in creating applications that utilise the NEPSE API.

Prerequisites

nepse-api works with Python 3.7 or higher. Support for earlier versions of Python is not provided. Python 2.7 or lower is not supported. Python 3.7 or lower is not supported.

Installing

You can get the library directly from PyPI:

python3 -m pip install -U nepse-api

If you are using Windows, then the following should be used instead:

py -3 -m pip install -U nepse-api

Virtual Environments

Sometimes you want to keep libraries from polluting system installs or use a different version of libraries than the ones installed on the system. You might also not have permissions to install libraries system-wide. For this purpose, the standard library as of Python 3.3 comes with a concept called “Virtual Environment”s to help maintain these separate versions.

A more in-depth tutorial is found on python-docs

However, for the quick and dirty:

1. Go to your project’s working directory:

   $ cd your-bot-source
   $ python3 -m venv bot-env
   

2. Activate the virtual environment:

   $ source bot-env/bin/activate
   

   On Windows you activate it with:

   $ bot-env\Scripts\activate.bat
   

3. Use pip like usual:

   $ pip install -U nepse-api
   

Congratulations. You now have a virtual environment all set up.