[CC-2] Django Init #1
Conversation
cc_licenses/cc_licenses/settings.py
Outdated
| # See https://docs.djangoproject.com/en/3.0/howto/deployment/checklist/ | ||
|
|
||
| # SECURITY WARNING: keep the secret key used in production secret! | ||
| SECRET_KEY = "g*l49b_4r6dmvh9&=3u)qfv@s!%ln6jgvi)_wgstlmn#_egzpn" |
There was a problem hiding this comment.
we usually don't commit the SECRET_KEY for our Django projects just so nobody deploys it accidentally with a key that's public. cc @aldenstpage
There was a problem hiding this comment.
Thank you for catching this. Going to follow up with you about this.
There was a problem hiding this comment.
In this case it's OK to load the Django secret key from an environment variable without a default. Django fails to start if someone has forgotten to set it. We do the same with our own Django projects. https://github.com/creativecommons/cccatalog-api/blob/master/cccatalog-api/cccatalog/settings.py#L26
The Django secret key doesn't need to be shared between us, we can generate our own when we deploy it.
There was a problem hiding this comment.
@aldenstpage and @kgodey, pushed changes addressing our conversation above.
There was a problem hiding this comment.
-
A bunch of .pyc files got added to the PR. It's probably simplest to add pycache to .gitignore and then
git rm -rall the pycache directories. -
I prefer not to nest the Django apps in a subdirectory of the repository, especially for a project that's not likely to ever get big. E.g. in https://github.com/creativecommons/cc-licenses/tree/CC-4-models I have a licenses app at the top level, alongside a cc_licenses package which has things like settings, urls.py, and wsgi.py. It's a matter of opinion, though.
| - id: trailing-whitespace | ||
| - id: end-of-file-fixer | ||
| - id: check-yaml | ||
| exclude: '^deploy/' |
There was a problem hiding this comment.
Why are we excluding deploy yaml files?
There was a problem hiding this comment.
Since we are not handling deployment, I didn't want to check those files @dpoirier. @aldenstpage, does CC use pre-commit for running test/checks? Would you find it useful when @TimidRobot sets up SALT to have those files checked/formatted?
There was a problem hiding this comment.
Oh right, then we shouldn't have anything under deploy/ so no need to exclude it.
There was a problem hiding this comment.
@dpoirier, pushed changes to address the bullet points above. I have removed licenses app since we'll pull that in from your PR.
|
Merged into #2 |
This PR:
cc_licenses(django project) andlicenses(django app) to the repo.pre-commitandcoverageMakefilefor automating getting started