A simple app to manage newsroom staff assignments.
Project description
django-assignment-desk
django-assignment-desk
is a simple Django app to store and manage weekly editorial staff assignments.
It depends on a staff list (such as the one provided by django-editorial-staff
), and returns a rich API that can be queried by any number of consumers (we're using it to feed both a read-only web interface and a chatbot).
More detailed documentation will be added at a later date.
Quick start
-
Install this app:
pip install django-assignment-desk
-
Add "assignment_desk" to your INSTALLED_APPS setting like this:
INSTALLED_APPS = [ ... 'assignment_desk', ]
-
Include the assignment_desk URLconf in your project urls.py like this:
url(r'^assignments/', include('assignment_desk.urls')),
-
Run
python manage.py migrate
to install the data models into your database. -
Start the development server and visit http://127.0.0.1:8000/assignments/ to start editing assignments.
-
Visit http://127.0.0.1:8000/assignments/api/ to explore the app's REST API.
Configuration
You can specify the following configuration options in your project's settings.py
file. All are optional:
Setting name | Intended value(s) | Purpose |
---|---|---|
ASSIGNMENT_DESK_LOGOUT_URL |
Any reversible URL pattern | If set, includes a "log out" link in the navigation on each django-assignment-desk page. |
Front-end development
django-assignment-desk
front-end pages are built using ES6 and SCSS, and this app includes a Gulp installation that converts files written in these dialects to plain JavaScript and CSS, respectively.
When developing on the front-end, you'll need to run this Gulp installation yourself. Follow these steps to get started.
-
Open a terminal window and navigate to the root of this app.
-
Within the app, navigate to
./assignment_desk/staticapp
. -
If this is your first time running Gulp on this project, run
npm install
to install JS dependencies. This may take several minutes. -
Once your dependencies are installed, run
gulp
to begin local development. -
When your Gulp server says it's up and running, visit http://127.0.0.1:3000/assignments/ for a live preview of your front-end files.
-
Proceed to modify your front-end interface by changing files in
./assignment_desk/staticapp/scss/
and./assignment_desk/staticapp/js/
. Your changes will be applied to the Gulp server URL without the need for to reload the page manually.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-assignment-desk-0.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad9ad5223ef11c48d46887e38af33c2e524717d46db64e9d37483312ff49bcc3 |
|
MD5 | cb249939a619456795ce74727afd988d |
|
BLAKE2b-256 | 04447169e328975d4c71da9feb35bc62cd15735a0589a959a844fd747a458f7b |
Hashes for django_assignment_desk-0.1.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 489522273046b7d55c9b81af2b4eb3b30741cbb16ce07c8d4d0bd3fa547bcaa5 |
|
MD5 | b3abdd791e9639a07454f984b56612c9 |
|
BLAKE2b-256 | e42d13606ac8ba99dbc8b52645f7e8d8178e5b7941b5be45a3edbf096e20baef |