Skip to main content

An Django Rest API for fetching and creating trips and their schedules.

Project description

Django Trips API

This is a Django Rest API for fetching and creating trips and schedules.

Installation

Simply do:

pip install django-trips

Usage

Add the app into your installed apps in your project's settings file.

INSTALLED_APPS = [
    ...
    'django_trips',
]

Add the following to your root urls.py file.

urlpatterns = [
    ...
    url(r'^trips/', include('django_trips.urls'))
]

Note that the URL path can be whatever you want.

Api

The following pages are served in the development:

Page Method URL
Trips List GET http://localhost:8000/api/trips/
Single Trip GET http://localhost:8000/api/trip/20/
Update Trip PUT http://localhost:8000/api/trip/20/
Delete Trip DELETE http://localhost:8000/api/trip/20/

Develop Django Trips

Kick the docker build using the following command.

make build

This task may take few minutes.

Once the build has been completed, spin up the docker and migrate the database.

> make run
> make shell 
> make update_db

Create a superuser with username admin.

> make shell
> python manage.py createsuperuser

Create batch of trips. Run the following command inside docker shell.

> python manage.py  generate_trips --batch_size=100
OR
> make random_trips

Docker Commands

Action Command
Run Server make run
Trail Logs make logs
Attach sever make attach
Stop server make stop
* Destroy docker container. make destory

* caution, this will remove all your data.

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

django-trips-0.2.3.tar.gz (2.5 kB view hashes)

Uploaded Source

Built Distribution

django_trips-0.2.3-py3-none-any.whl (2.9 kB view hashes)

Uploaded Python 3

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