Trackex API

Built for Texada Software

On Your Marks

• Make sure you have Python 3.6+ installed. If you need installation help.
  • Confirm you have pip (PyPi), installed and in your path.
  • python --version - Should confirm the version of python you have in your path.
  • python -m pip --version - Should confirm the version of pip you have installed.
  • pip --version - Should confirm that you have pip in your path.
• Create .env file using .env.example. All values are important.
• Make sure python has all requirements installed.
  • pip install -r requirements.txt
• Run database migrations
  • python manage.py makemigrations
  • python manage.py migrate
• Import quick start data
  • python manage.py loaddata trackex/fixtures/initial_data_auth.json
  • python manage.py loaddata api/fixtures/initial_data_api.json

Ready Set Go

• python manage.py runserver [PORT]
• Visit http://[yourhost]:[PORT] to check out the browsable api
• Add .json to urls or set your header to accept json responses
  • Or simply use a web api client
• END POINTS
  • /packages - list of packages
    • GET - get paginated list
    • POST - create new package
  • /packages/{id} - single pacakge
    • GET - get package resource
    • PUT PATCH - update package
    • DELETE - delete package and tracking information PERMISSION:SUPERUSER
  • /packages/{id}/tracking - package tracking
    • GET - paginated status list ordered by recency
    • POST - create new package status update
  • /status/{id} - status detail
    • DELETE - delete tracking status PERMISSION:SUPERUSER

Wait Hold Up

• One way to run tests
  • python manage.py test
• For test coverage analysis
  • coverage run --source=. manage.py test
  • coverage report -m