trading_api

An API for trading and buying products from one another. Assignment for course M7011E on LTU.

Get started with the project dev environment

Prerequisites

python 3.x.x
pyenv (optional)
Django (if not running with pyenv)

Cloning the repo

Create a folder, for example M7011E, then enter it and run:

git init
git clone https://github.com/M7011E-django-unchained/trading_api

in the terminal.

The project is now cloned but if you want to have a unique development environment for the project (which is recommended) you need to setup an environment using pyenv.

Setting up pyenv (optional)

Make sure you have pyenv installed before starting this steps. This creates the unique environment for the project and starts it. This can be checked with:

pyenv --version

If you have pyenv installed correctly then you will have to choose your python version for the project environment, anything in the later stages of python3 should work. To check for the available python releases run:

pyenv install -l

Then, install one of choice (preferable the latest stable version). For example:

pyenv install 3.12.0

For windows users: Enter the project root folder trading_api and run:

pyenv local 3.12.0 #Same as one you've installed earlier
python -m venv .env
.env\Scripts\activate.bat

Not tested!! For linux/unix users Enter the project root folder trading_api and run:

python -m venv .env
source .virtenv/bin/activate

Install required packages on environment (if not on env, packages needs to be installed globally)

Just run:

pip install -r requirements.txt

in the project root folder and check that the installation was correct with:

pip freeze

which should return something like:

asgiref==3.7.2
certifi==2023.11.17
charset-normalizer==3.3.2
Django==4.2.7
django-cors-headers==4.3.1
django-extensions==3.2.3
djangorestframework==3.14.0
djangorestframework-simplejwt==5.3.1
flake8==6.1.0
idna==3.6
mccabe==0.7.0
pika==1.3.2
Pillow==10.1.0
pycodestyle==2.11.1
pyflakes==3.1.0
PyJWT==2.8.0
pytz==2023.3.post1
requests==2.31.0
sqlparse==0.4.4
tzdata==2023.3
urllib3==2.1.0
django-debug-toolbar==4.2.0
django-seed==0.3.1
drf-spectacular==0.26.5
psycopg2-binary==2.9.9

Run the project in dev mode

Run the Django-server from the project root-folder in a terminal with:

python manage.py runserver