Use actual, real-life data #9
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The app will be much easier to test (and grow) if it's set up as an importable package. The prompt for this reorganization was writing the tests, but I think it'll be all-around easier to work with this way. For more information on python packages, check here: https://docs.python.org/3/tutorial/modules.html#packages
Works towards #7 This commit adds test-driven objects that represent state and district voter data, both able to calculate the required values on themselves. It contains all methods and attributes needed for our current vision of the API. In order to complete #7, I need to actually query the database.
Resolves #7 The `/api/states/ohio` endpoint now uses real data from the database! Other notable changes: - Remove Flask-SQLAlchemy. Our database is single table and very denormalized, and we're only using a single query. Because of this, we don't need the specialized Flask-SQLAlchemy interface; a simple SQLAlchemy query will suffice. - Resource endpoints (ex. /api/ and /states/) now have a trailing slash. Omitting this slash will cause a 301 redirect. - Reorganize API to use `data`, `meta`, and `links` keys. I'm not sure if we'll keep them, but it makes the API more consistent. Next up: - Tests should not run against the production database - Fix the Travis build
Fix the build. I installed progress_report in editable mode (`pip install -e .`) in order to allow `pytest` to find the project root. This breaks both Travis and the Heroku build, and it's not a good idea for production. This commit removes that dependency and changes Travis's test script to `python3 -m pytest`; that should allow pytest to load the module without including an editable dependency.
The goal of this commit is to get Travis to pass. This commit introduces a fair amount of technical debt. The reasoning is that until we add database migrations (and possibly figure out our long-term table structure), it'll be difficult to test with postgresql. Because of this, this commit introduces an in-memory sqlite database for testing.
|
It's now functional, but the code's messier than I'd like. Some of that will stay until we figure out what we're doing with the database, but a lot of it can be improved. I'm adding docstrings and cleaning some stuff up now. |
|
Just kidding. Things may move around a lot before the mvp, so I don't want to lock them in with comments. I'll document and clean things up a bit when the code's more stable. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #7
This PR contains three major updates:
DistrictVoterDataandStateVoterData)After this point, we should be able to delete the
/api/hackathonendpoint and use real data to develop the front-end.