jkettler / cs373-idb Goto Github PK

• list all the votes or summarize votes

*look at senator's page

Improve look & feel of base layout either just with bootstrap or some freely available bootstrap layout/theme.

Model the "votes" in the in-progress API and add basic data for testing.

• name file Models.py

-1 Your API supports multiple vice_chairs on a committee, but your models only support one.
-2 You should only define the ManyToMany field on one of the models, it's autogenerated on the other side.

Create the test cases and a test file for the API in Python and commit it to the repo

• document interfaces of classes
• use inline comments
• A consistent coding convention with good variable names, good indentation, blank lines, and blank spaces

Since author was removed from the Bill model, it is now impossible to add a new bill since author was a required field.

Committee can't be referenced without being defined, so the order must be swapped. This creates the same issue with Senator. The solution is to provide a ForeignKey to the committees definition in Senator. See: http://stackoverflow.com/questions/18303406/name-is-not-defined-in-django-model

• use labels
• mark each issue with milestone

Author field is gone from bill, and instead there is now a "authors" relationship on bill with a reciprocal "bill_set" on senator. This new many to many relation replaces the old one-to-many author relationship. Apiary needs to be updated accordingly

Additionally, we must make certain that other changes did not go unnoticed, and that apiary is in sync with our django models.

The diagram only needs to show the associations and multiplicity between the classes.

• link commits to corresponding issues

-0 Rename 'author' to 'authors'
-0 Use null instead of 'none'
-0 For votes on a bill, use integer keys instead of strings (since they are IDs)
-1 POST body shouldn't be an array

• Check if many-to-many relationships should be removed from the API, i.e. things like listing the committees for a senator and listing all the senators in a committee. If not, then add list of bills authored to senator
• Post the API to the public repository.

Somehow we ended up with an older version of Bootstrap and JQuery, this should be upgraded

• Post the Django models to the public repository.

Add API info to the 10 page document that we need to turn in

• minimum of 10 pages
• name file Report.pdf

• 3 bills
• 3 senators
• 3 committees

The option to have multiple vice chairs should be removed. This needs to be updated in:

-The apiary API blueprint
-The tests.py file
-The graders public repo

Create a function in django, change html as necessary

example: http://www.senate.state.tx.us/75r/senate/commit/c500/c500.htm

I went over the Django models and compared them with my API and fixed a few bugs with the API and only noticed one minor thing with the models.py file:

In the Senator class, instead of "full_name" i have the field "name" in the API. Just "name" seems preferable to "full_name" for consistency.

That's the only thing that needs to be changed right now though.

Document the RESTful API and the Django models well.

• test corner cases and failure cases
• A clone of the public test repo with a copy of unit tests in the files -tests.py and -tests.out

bill -> senator
senator -> committee

• Make sure to embed the different media.
• Make sure that everything that can be linkable is.
• Try improving the layout when viewing a bill or committee (according to Alex)

Implement the API using tastypie