submarcos / django-vectortiles

Mapbox VectorTiles for django, with PostGIS or Python
https://django-vectortiles.readthedocs.io
MIT License
42 stars 11 forks source link

Improve code quality and documentation #34

Closed submarcos closed 1 year ago

codecov[bot] commented 1 year ago

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage :thumbsup:

Coverage data is based on head (791aad1) compared to base (c92628b). Patch coverage: 100.00% of modified lines in pull request are covered.

:exclamation: Current head 791aad1 differs from pull request most recent head 9b53743. Consider uploading reports for the commit 9b53743 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #34 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 11 12 +1 Lines 275 279 +4 ========================================= + Hits 275 279 +4 ``` | [Impacted Files](https://codecov.io/gh/submarcos/django-vectortiles/pull/34?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jean-Etienne+Castagnede) | Coverage Δ | | |---|---|---| | [vectortiles/mapbox/mixins.py](https://codecov.io/gh/submarcos/django-vectortiles/pull/34?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jean-Etienne+Castagnede#diff-dmVjdG9ydGlsZXMvbWFwYm94L21peGlucy5weQ==) | `100.00% <100.00%> (ø)` | | | [vectortiles/mixins.py](https://codecov.io/gh/submarcos/django-vectortiles/pull/34?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jean-Etienne+Castagnede#diff-dmVjdG9ydGlsZXMvbWl4aW5zLnB5) | `100.00% <100.00%> (ø)` | | | [vectortiles/postgis/functions.py](https://codecov.io/gh/submarcos/django-vectortiles/pull/34?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jean-Etienne+Castagnede#diff-dmVjdG9ydGlsZXMvcG9zdGdpcy9mdW5jdGlvbnMucHk=) | `100.00% <100.00%> (ø)` | | | [vectortiles/postgis/mixins.py](https://codecov.io/gh/submarcos/django-vectortiles/pull/34?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jean-Etienne+Castagnede#diff-dmVjdG9ydGlsZXMvcG9zdGdpcy9taXhpbnMucHk=) | `100.00% <100.00%> (ø)` | | | [vectortiles/rest\_framework/renderers.py](https://codecov.io/gh/submarcos/django-vectortiles/pull/34?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jean-Etienne+Castagnede#diff-dmVjdG9ydGlsZXMvcmVzdF9mcmFtZXdvcmsvcmVuZGVyZXJzLnB5) | `100.00% <100.00%> (ø)` | | | [vectortiles/settings.py](https://codecov.io/gh/submarcos/django-vectortiles/pull/34?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jean-Etienne+Castagnede#diff-dmVjdG9ydGlsZXMvc2V0dGluZ3MucHk=) | `100.00% <100.00%> (ø)` | | | [vectortiles/tests/test\_functions.py](https://codecov.io/gh/submarcos/django-vectortiles/pull/34?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jean-Etienne+Castagnede#diff-dmVjdG9ydGlsZXMvdGVzdHMvdGVzdF9mdW5jdGlvbnMucHk=) | `100.00% <100.00%> (ø)` | | | [vectortiles/tests/test\_mixins.py](https://codecov.io/gh/submarcos/django-vectortiles/pull/34?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jean-Etienne+Castagnede#diff-dmVjdG9ydGlsZXMvdGVzdHMvdGVzdF9taXhpbnMucHk=) | `100.00% <100.00%> (ø)` | | | [vectortiles/tests/test\_views.py](https://codecov.io/gh/submarcos/django-vectortiles/pull/34?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jean-Etienne+Castagnede#diff-dmVjdG9ydGlsZXMvdGVzdHMvdGVzdF92aWV3cy5weQ==) | `100.00% <100.00%> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jean-Etienne+Castagnede). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jean-Etienne+Castagnede)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

gitguardian[bot] commented 1 year ago

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
| GitGuardian id | Secret | Commit | Filename | | | -------------- | ------------------------- | ---------------- | --------------- | -------------------- | | [371130](https://dashboard.gitguardian.com/incidents/371130?occurrence=84577376) | Django Secret Key | 28dd7dbba0b5e698a092e50ad7b9d30258b98191 | test_vectortiles/settings.py | [View secret](https://github.com/submarcos/django-vectortiles/commit/28dd7dbba0b5e698a092e50ad7b9d30258b98191#diff-06b5a0abbe339443f9973995e1abc8e0b8ebdc36aa8e1261a2839a120203ac46L23) | | [371130](https://dashboard.gitguardian.com/incidents/371130?occurrence=84577377) | Django Secret Key | 28dd7dbba0b5e698a092e50ad7b9d30258b98191 | test_vectortiles/settings.py | [View secret](https://github.com/submarcos/django-vectortiles/commit/28dd7dbba0b5e698a092e50ad7b9d30258b98191#diff-06b5a0abbe339443f9973995e1abc8e0b8ebdc36aa8e1261a2839a120203ac46R23) |
🛠 Guidelines to remediate hardcoded secrets
1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secrets safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate these secrets](https://docs.gitguardian.com/secrets-detection/detectors/specifics/secret_key_in_django_config#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data. To avoid such incidents in the future consider - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!