Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sdclarkelab/stockwatch-api
StockWatchJa API
https://github.com/sdclarkelab/stockwatch-api
api django-rest-framework docker docker-compose heroku jamaica jamstockex postgresql python stockwatch-api stockwatchja
Last synced: 29 days ago
JSON representation
StockWatchJa API
- Host: GitHub
- URL: https://github.com/sdclarkelab/stockwatch-api
- Owner: sdclarkelab
- Created: 2020-06-14T01:09:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-03-07T02:29:41.000Z (almost 3 years ago)
- Last Synced: 2023-03-07T21:44:57.949Z (almost 2 years ago)
- Topics: api, django-rest-framework, docker, docker-compose, heroku, jamaica, jamstockex, postgresql, python, stockwatch-api, stockwatchja
- Language: Python
- Homepage:
- Size: 162 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# StockWatchJa API
This is the server for the StockWatchJa application. It pulls stock trade data from **[StockWatchJA: JamStockEx API](https://github.com/sdclarkelab/jamstockex-api)** at this [URL](http://jamstockexapi.stockwatchja.com/stocks).
## API Documentation
Click [here](https://documenter.getpostman.com/view/6678518/S1TU3eAz) to view the API documentation.
## Requirements
Tool | Version | Source |
--- | --- | --- |
Python |3.7.4| [Python 3.7.4 Release](https://www.python.org/downloads/release/python-374/)|
Heroku|-|[Getting Started on Heroku with Python](https://devcenter.heroku.com/articles/getting-started-with-python)|
Windows OS| 10 | - |
Docker| 19.03.4| [Docker Desktop](https://www.docker.com/products/docker-desktop)|
### Setup Dev
#### Create Django dev setting file
Export settings module:
- On Windows: `set DJANGO_SETTINGS_MODULE=development.local_settings`
- On Linux: `export DJANGO_SETTINGS_MODULE=development.local_settings`
#### Create and initialize Docker database
``` shell script
# Create Postgres database Docker container and create schema
> python development/dev_setup.py
# Create admin user
> python manage.py createsuperuser
```
#### Test Super User Credentials
```shell script
> python manage.py runserver 5555
```
Login to [admin page](http://127.0.0.1:5555/api/v1/stockwatch_admin/) with super user credentials to confirm it works.
(use "***[custom_admin_page](http://docker_ip_add/api/v1/stockwatch_admin/)***" if the docker-machine ip is not using the default IP address)
#### Register Application
Go to [application registration](http://127.0.0.1:5555/api/v1/stockwatch_admin/o/applications/) and complete the form.
(use "***[custom application registration](http://docker_ip_add/api/v1/stockwatch_admin/o/applications/)***" if the docker-machine ip is not using the default IP address)
> Name: StockwatchAPI
>
> Client type: Confidential
>
> Authorization grant type: Resource owner password-based