📝 Adds awesome-lint support and lints repo

This commit is contained in:
Jeff Triplett 2020-07-04 12:45:35 -05:00
parent 4d1571e190
commit f025108b06
No known key found for this signature in database
GPG Key ID: BD6DAFC4D1A381EA
3 changed files with 120 additions and 111 deletions

11
.github/workflows/lint.yml vendored Normal file
View File

@ -0,0 +1,11 @@
name: Lint Awesome List
on: [push, pull_request]
jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1.0.0
- uses: max/awesome-lint@v2.0.0

View File

@ -2,8 +2,12 @@ build: toc
.PHONY: alex
alex:
npx alex README.md
@npx alex README.md
.PHONY: lint
lint:
@npx awesome-lint README.md
.PHONY: toc
toc:
npx doctoc README.md
@npx doctoc README.md

212
README.md
View File

@ -52,7 +52,6 @@
- [DRF Tutorials](#drf-tutorials)
- [Wagtail](#wagtail)
- [Wagtail Resources](#wagtail-resources)
- [License](#license)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@ -60,151 +59,151 @@
_For a complete listing of all available packages, see [Django Packages](https://djangopackages.org/)_
- [django-filter](https://github.com/carltongibson/django-filter) - Powerful filters based on Django QuerySets
- [django-guardian](https://github.com/django-guardian/django-guardian) - Per object permissions in Django
- [django-sql-explorer](https://github.com/groveco/django-sql-explorer) - Share data via SQL queries
- [django-tables2](https://github.com/jieter/django-tables2) - HTML tables with pagination/sorting
- [django-filter](https://github.com/carltongibson/django-filter) - Powerful filters based on Django QuerySets.
- [django-guardian](https://github.com/django-guardian/django-guardian) - Per object permissions in Django.
- [django-sql-explorer](https://github.com/groveco/django-sql-explorer) - Share data via SQL queries.
- [django-tables2](https://github.com/jieter/django-tables2) - HTML tables with pagination/sorting.
### Admin
- [django-grappelli](https://github.com/sehmaschine/django-grappelli) - A jazzy skin for the admin
- [django-hijack](https://github.com/arteria/django-hijack) - Admins can log in and work on behalf of other users without having to know their credentials
- [django-import-export](https://github.com/django-import-export/django-import-export) - Django application and library for importing and exporting data with admin integration
- [django-admin-honeypot](https://github.com/dmpayton/django-admin-honeypot) - Configure a honeypot to see who's trying to hack your site
- [django-loginas](https://github.com/skorokithakis/django-loginas) - "Log in as user" for the Django admin
- [django-grappelli](https://github.com/sehmaschine/django-grappelli) - A jazzy skin for the admin.
- [django-hijack](https://github.com/arteria/django-hijack) - Admins can log in and work on behalf of other users without having to know their credentials.
- [django-import-export](https://github.com/django-import-export/django-import-export) - Django application and library for importing and exporting data with admin integration.
- [django-admin-honeypot](https://github.com/dmpayton/django-admin-honeypot) - Configure a honeypot to see who's trying to hack your site.
- [django-loginas](https://github.com/skorokithakis/django-loginas) - "Log in as user" for the Django admin.
- [impostor](https://github.com/avallbona/Impostor) - Impostor is a Django application which allows staff members to login as a different user by using their own username and password.
### APIs
- [django-rest-framework](https://github.com/encode/django-rest-framework) - Web APIs for Django
- [django-cors-headers](https://github.com/adamchainz/django-cors-headers) - If your back-end and front-end are on different servers, you need this
- [dj-rest-auth](https://github.com/jazzband/dj-rest-auth) - Authentication for Django Rest Framework
- [django-rest-knox](https://github.com/James1345/django-rest-knox) - Authentication Module for django-rest-auth
- [djoser](https://github.com/sunscrapers/djoser) - REST implementation of Django auth
- [django-rest-framework-simplejwt](https://github.com/davesque/django-rest-framework-simplejwt) - JSON web tokens for DRF
- [django-webpack-loader](https://github.com/owais/django-webpack-loader) - Transparently use webpack with Django
- [drf-yasg](https://github.com/axnsan12/drf-yasg) - Automated generation of real Swagger/OpenAPI 2.0 schemas from Django REST Framework code
- [graphene-django](https://github.com/graphql-python/graphene-django) - GraphQL for Django
- [django-rest-framework](https://github.com/encode/django-rest-framework) - Web APIs for Django.
- [django-cors-headers](https://github.com/adamchainz/django-cors-headers) - If your back-end and front-end are on different servers, you need this.
- [dj-rest-auth](https://github.com/jazzband/dj-rest-auth) - Authentication for Django Rest Framework.
- [django-rest-knox](https://github.com/James1345/django-rest-knox) - Authentication Module for django-rest-auth.
- [djoser](https://github.com/sunscrapers/djoser) - REST implementation of Django auth.
- [django-rest-framework-simplejwt](https://github.com/davesque/django-rest-framework-simplejwt) - JSON web tokens for DRF.
- [django-webpack-loader](https://github.com/owais/django-webpack-loader) - Transparently use webpack with Django.
- [drf-yasg](https://github.com/axnsan12/drf-yasg) - Automated generation of real Swagger/OpenAPI 2.0 schemas from Django REST Framework code.
- [graphene-django](https://github.com/graphql-python/graphene-django) - GraphQL for Django.
### Async
- [channels](https://github.com/django/channels/) - Async support for Django
- [starlette](https://github.com/encode/starlette) - ASGI framework
- [channels](https://github.com/django/channels/) - Async support for Django.
- [starlette](https://github.com/encode/starlette) - ASGI framework.
### Commands
- [django-extensions](https://github.com/django-extensions/django-extensions/) - Custom management extensions, notably `runserver_plus` and `shell_plus`
- [django-click](https://github.com/GaretJax/django-click) - Write Django management commands using the click CLI library
- [django-dbbackup](https://github.com/django-dbbackup/django-dbbackup) - Management commands to help backup and restore your project database and media files
- [django-extensions](https://github.com/django-extensions/django-extensions/) - Custom management extensions, notably `runserver_plus` and `shell_plus`.
- [django-click](https://github.com/GaretJax/django-click) - Write Django management commands using the click CLI library.
- [django-dbbackup](https://github.com/django-dbbackup/django-dbbackup) - Management commands to help backup and restore your project database and media files.
### Configuration
- [confidential](https://github.com/candidco/confidential) - Manage configs and secrets (with CLI support)
- [django-environ](https://github.com/joke2k/django-environ) - Environment variables
- [django-split-settings](https://github.com/sobolevn/django-split-settings) - Organize multiple settings files
- [confidential](https://github.com/candidco/confidential) - Manage configs and secrets (with CLI support).
- [django-environ](https://github.com/joke2k/django-environ) - Environment variables.
- [django-split-settings](https://github.com/sobolevn/django-split-settings) - Organize multiple settings files.
### Content Management Systems
- [wagtail](https://github.com/wagtail/wagtail) - Popular Django content management system (CMS). See [awesome-wagtail](https://github.com/springload/awesome-wagtail) too.
- [mezzanine](https://github.com/stephenmcd/mezzanine) - CMS framework
- [django-cms](https://github.com/divio/django-cms) - CMS for Django
- [puput](https://github.com/APSL/puput) - Blog app features with Wagtail
- [mezzanine](https://github.com/stephenmcd/mezzanine) - CMS framework.
- [django-cms](https://github.com/divio/django-cms) - CMS for Django.
- [puput](https://github.com/APSL/puput) - Blog app features with Wagtail.
### ECommerce
- [saleor](https://github.com/mirumee/saleor) - GraphQL-based Django E-Commerce Platform
- [django-shop](https://github.com/awesto/django-shop) - Django-based shop system
- [shuup](https://github.com/shuup/shuup) - Django E-Commerce Platform
- [django-oscar](https://github.com/django-oscar/django-oscar) - Domain-driven e-commerce for Django
- [saleor](https://github.com/mirumee/saleor) - GraphQL-based Django E-Commerce Platform.
- [django-shop](https://github.com/awesto/django-shop) - Django-based shop system.
- [shuup](https://github.com/shuup/shuup) - Django E-Commerce Platform.
- [django-oscar](https://github.com/django-oscar/django-oscar) - Domain-driven e-commerce for Django.
### Files/Images
- [django-cleanup](https://github.com/un1t/django-cleanup) - Zero configuration file/image removal for local and remote files
- [django-cleanup](https://github.com/un1t/django-cleanup) - Zero configuration file/image removal for local and remote files.
### Forms
- [django-crispy-forms](https://github.com/django-crispy-forms/django-crispy-forms/) - DRY Django forms
- [django-widget-tweaks](https://github.com/jazzband/django-widget-tweaks) - Tweak form field rendering in templates
- [django-autocomplete-light](https://github.com/yourlabs/django-autocomplete-light) - Add autocompletion to forms
- [django-shapeshifter](https://github.com/kennethlove/django-shapeshifter) - A CBV to handle multiple forms in one view
- [django-crispy-forms](https://github.com/django-crispy-forms/django-crispy-forms/) - DRY Django forms.
- [django-widget-tweaks](https://github.com/jazzband/django-widget-tweaks) - Tweak form field rendering in templates.
- [django-autocomplete-light](https://github.com/yourlabs/django-autocomplete-light) - Add autocompletion to forms.
- [django-shapeshifter](https://github.com/kennethlove/django-shapeshifter) - A CBV to handle multiple forms in one view.
### Logging
- [django-guid](https://github.com/JonasKs/django-guid) - Inject a GUID (Correlation-ID) into every log message in a Django request.
### Models
- [django-fakery](https://github.com/fcurella/django-fakery) - An easy-to-use implementation of Creation Methods for Django, backed by Faker
- [django-lifecycle](https://github.com/rsinger86/django-lifecycle) - Declarative model lifecycle hooks, an alternative to Signals
- [django-model-utils](https://github.com/jazzband/django-model-utils) - Django model mixins and utilities
- [django-money](https://github.com/django-money/django-money) - Money fields for forms/models
- [django-phonenumber-field](https://github.com/stefanfoulis/django-phonenumber-field) - Model/form field for normalized phone numbers
- [django-taggit](https://github.com/jazzband/django-taggit/) - Simple model tags
- [django-reversion](https://github.com/etianen/django-reversion) - Version control for model instances
- [django-simple-history](https://github.com/treyhunner/django-simple-history) - Store model history and view/revert changes from the admin
- [django-fakery](https://github.com/fcurella/django-fakery) - An easy-to-use implementation of Creation Methods for Django, backed by Faker.
- [django-lifecycle](https://github.com/rsinger86/django-lifecycle) - Declarative model lifecycle hooks, an alternative to Signals.
- [django-model-utils](https://github.com/jazzband/django-model-utils) - Django model mixins and utilities.
- [django-money](https://github.com/django-money/django-money) - Money fields for forms/models.
- [django-phonenumber-field](https://github.com/stefanfoulis/django-phonenumber-field) - Model/form field for normalized phone numbers.
- [django-taggit](https://github.com/jazzband/django-taggit/) - Simple model tags.
- [django-reversion](https://github.com/etianen/django-reversion) - Version control for model instances.
- [django-simple-history](https://github.com/treyhunner/django-simple-history) - Store model history and view/revert changes from the admin.
- [django-polymorphic](https://github.com/django-polymorphic/django-polymorphic) - Django-polymorphic simplifies using inherited models in Django projects.
### Performance
- [django-perf-rec](https://cur.at/GHUO6cn?m=web) - Keep detailed records of the performance of your Django code
- [New Relic](https://newrelic.com/python/django) - Time middleware, views, and SQL queries
- [Scout](https://docs.scoutapm.com/#django) - Time middleware, template rendering, and SQL queries with automatic N+1 detection
- [django-query-profiler](https://github.com/django-query-profiler/django-query-profiler) - Django query profiler to help resolve N+1 queries
- [django-silk](https://github.com/jazzband/django-silk) - Silky smooth profiling for Django
- [py-spy](https://github.com/benfred/py-spy) - Sampling profiler for Python programs
- [django-perf-rec](https://cur.at/GHUO6cn?m=web) - Keep detailed records of the performance of your Django code.
- [New Relic](https://newrelic.com/python/django) - Time middleware, views, and SQL queries.
- [Scout](https://docs.scoutapm.com/#django) - Time middleware, template rendering, and SQL queries with automatic N+1 detection.
- [django-query-profiler](https://github.com/django-query-profiler/django-query-profiler) - Django query profiler to help resolve N+1 queries.
- [django-silk](https://github.com/jazzband/django-silk) - Silky smooth profiling for Django.
- [py-spy](https://github.com/benfred/py-spy) - Sampling profiler for Python programs.
### Search
- [django-haystack](https://github.com/django-haystack/django-haystack) - Modular search for Django
- [django-watson](https://github.com/etianen/django-watson) - Full-text search plugin
- [django-haystack](https://github.com/django-haystack/django-haystack) - Modular search for Django.
- [django-watson](https://github.com/etianen/django-watson) - Full-text search plugin.
### Static Assets
- [django-storages](https://github.com/jschneier/django-storages) - A single library to support multiple custom storage backends for Django
- [django-compressor](https://github.com/django-compressor/django-compressor/) - Compress JavaScript/CSS into a single cached file
- [easy-thumbnails](https://github.com/SmileyChris/easy-thumbnails) - Image thumbnails for Django
- [django-storages](https://github.com/jschneier/django-storages) - A single library to support multiple custom storage backends for Django.
- [django-compressor](https://github.com/django-compressor/django-compressor/) - Compress JavaScript/CSS into a single cached file.
- [easy-thumbnails](https://github.com/SmileyChris/easy-thumbnails) - Image thumbnails for Django.
### Task Queues
- [beatserver](https://github.com/rajasimon/beatserver) - A periodic task scheduler for Django
- [django-q](https://github.com/Koed00/django-q) - A multiprocessing distributed task queue
- [django-rq](https://github.com/rq/django-rq) - Integration for Redis Queue
- [django-redis](https://github.com/niwinz/django-redis) - Full featured Redis cache backend for Django
- [celery](https://github.com/celery/celery) - Robust and broker-agnostic task queues for bigger, performance-focused projects
- [beatserver](https://github.com/rajasimon/beatserver) - A periodic task scheduler for Django.
- [django-q](https://github.com/Koed00/django-q) - A multiprocessing distributed task queue.
- [django-rq](https://github.com/rq/django-rq) - Integration for Redis Queue.
- [django-redis](https://github.com/niwinz/django-redis) - Full featured Redis cache backend for Django.
- [celery](https://github.com/celery/celery) - Robust and broker-agnostic task queues for bigger, performance-focused projects.
### Testing
- [django-debug-toolbar](https://github.com/jazzband/django-debug-toolbar/) - Configurable panels to debug requests/responses
- [pytest-django](https://github.com/pytest-dev/pytest-django) - Use pytest features in Django
- [django-test-migrations](https://github.com/wemake-services/django-test-migrations) - Test django schema and data migrations, including migrations' order
- [django-test-plus](https://github.com/revsys/django-test-plus/) - Useful additions to Django's default TestCase
- [factory-boy](https://github.com/FactoryBoy/factory_boy) - Test fixtures replacement
- [django-silk](https://github.com/jazzband/django-silk) - Live profiling and inspection of HTTP requests and database queries
- [django-waffle](https://github.com/django-waffle/django-waffle) - A feature flipper for Django
- [model-bakery](https://github.com/model-bakers/model_bakery) - Object factory for Django (rename of legacy Model Mommy project)
- [django-swagger-tester](https://github.com/sondrelg/django-swagger-tester) - Django test utility for validating Swagger documentation
- [django-debug-toolbar](https://github.com/jazzband/django-debug-toolbar/) - Configurable panels to debug requests/responses.
- [pytest-django](https://github.com/pytest-dev/pytest-django) - Use pytest features in Django.
- [django-test-migrations](https://github.com/wemake-services/django-test-migrations) - Test django schema and data migrations, including migrations' order.
- [django-test-plus](https://github.com/revsys/django-test-plus/) - Useful additions to Django's default TestCase.
- [factory-boy](https://github.com/FactoryBoy/factory_boy) - Test fixtures replacement.
- [django-silk](https://github.com/jazzband/django-silk) - Live profiling and inspection of HTTP requests and database queries.
- [django-waffle](https://github.com/django-waffle/django-waffle) - A feature flipper for Django.
- [model-bakery](https://github.com/model-bakers/model_bakery) - Object factory for Django (rename of legacy Model Mommy project).
- [django-swagger-tester](https://github.com/sondrelg/django-swagger-tester) - Django test utility for validating Swagger documentation.
### URLs
- [dj-database-url](https://github.com/jacobian/dj-database-url) - Database URLs
- [urlman](https://github.com/andrewgodwin/urlman) - A nicer way to do URLs for Django models
- [dj-database-url](https://github.com/jacobian/dj-database-url) - Database URLs.
- [urlman](https://github.com/andrewgodwin/urlman) - A nicer way to do URLs for Django models.
### Users
- [django-allauth](https://github.com/pennersr/django-allauth/) - Improved user registration including social auth
- [django-organizations](https://github.com/bennylope/django-organizations/) - Multi-user accounts for Django projects
- [django-allauth](https://github.com/pennersr/django-allauth/) - Improved user registration including social auth.
- [django-organizations](https://github.com/bennylope/django-organizations/) - Multi-user accounts for Django projects.
### Views
- [django-braces](https://github.com/brack3t/django-braces) - Reusable, generic mixins
- [django-extra-views](https://github.com/AndrewIngram/django-extra-views) - Extra class-based generic views
- [django-vanilla-views](https://github.com/tomchristie/django-vanilla-views) - Simpler class-based views in Django
- [django-stronghold](https://github.com/mgrouchy/django-stronghold) - Makes all your Django views default login_required
- [django-braces](https://github.com/brack3t/django-braces) - Reusable, generic mixins.
- [django-extra-views](https://github.com/AndrewIngram/django-extra-views) - Extra class-based generic views.
- [django-vanilla-views](https://github.com/tomchristie/django-vanilla-views) - Simpler class-based views in Django.
- [django-stronghold](https://github.com/mgrouchy/django-stronghold) - Makes all your Django views default login_required.
## Python Packages
_A short list of Python packages that work well with Django._
- [bleach](https://github.com/mozilla/bleach) - Sanitize your inputs/forms
- [black](https://github.com/psf/black) - Uncompromising Python code formatter
- [coveragepy](https://github.com/nedbat/coveragepy) - Code coverage measurement
- [huey](https://github.com/coleifer/huey) - A little task queue for Python
- [nplusone](https://github.com/jmcarp/nplusone) - Auto-detect n+1 queries
- [pillow](https://github.com/python-pillow/Pillow) - Python Imaging Library
- [pytest](https://github.com/pytest-dev/pytest/) - Testing framework
- [python-slugify](https://github.com/un33k/python-slugify) - Returns unicode slugs
- [sentry-python](https://github.com/getsentry/sentry-python) - Error reporting SDK
- [whitenoise](https://github.com/evansd/whitenoise) - Simplified static file serving for Python websites
- [bleach](https://github.com/mozilla/bleach) - Sanitize your inputs/forms.
- [black](https://github.com/psf/black) - Uncompromising Python code formatter.
- [coveragepy](https://github.com/nedbat/coveragepy) - Code coverage measurement.
- [huey](https://github.com/coleifer/huey) - A little task queue for Python.
- [nplusone](https://github.com/jmcarp/nplusone) - Auto-detect n+1 queries.
- [pillow](https://github.com/python-pillow/Pillow) - Python Imaging Library.
- [pytest](https://github.com/pytest-dev/pytest/) - Testing framework.
- [python-slugify](https://github.com/un33k/python-slugify) - Returns unicode slugs.
- [sentry-python](https://github.com/getsentry/sentry-python) - Error reporting SDK.
- [whitenoise](https://github.com/evansd/whitenoise) - Simplified static file serving for Python websites.
## Resources
### Official Resources
- [Project Website](https://www.djangoproject.com/) - Official Django website
- [Documentation](https://docs.djangoproject.com/en/dev/) - Comprehensive documentation for all Django versions
- [Polls Tutorial](https://docs.djangoproject.com/en/dev/intro/tutorial01/) - Build a polls tutorial while learning Django internals
- [Source Code](https://github.com/django/django/) - Hosted on GitHub
- [Project Website](https://www.djangoproject.com/) - Official Django website.
- [Documentation](https://docs.djangoproject.com/en/dev/) - Comprehensive documentation for all Django versions.
- [Polls Tutorial](https://docs.djangoproject.com/en/dev/intro/tutorial01/) - Build a polls tutorial while learning Django internals.
- [Source Code](https://github.com/django/django/) - Hosted on GitHub.
### Educational
@ -225,12 +224,12 @@ _A short list of Python packages that work well with Django._
### Community
- [Django Forum](https://forum.djangoproject.com/) - Discourse Board
- [Django Forum](https://forum.djangoproject.com/) - Discourse Board.
- [Community Page](https://www.djangoproject.com/community/) - Featuring feeds of Community Blog Posts, Jobs, and more.
- [Django Users Google Group](https://groups.google.com/forum/#!forum/django-users/) - Very active discussion board for questions/answers.
- [Developers Google Group](https://groups.google.com/forum/#!forum/django-developers/) - For contributions to Django itself only.
- [Twitter](https://twitter.com/djangoproject/) - For official announcements on updates, security fixes, etc.
- IRC Channel - Chat with other Django users at irc://irc.freenode.net/django
- IRC Channel - Chat with other Django users at irc://irc.freenode.net/django.
### Conferences
@ -315,22 +314,21 @@ _Django 1.11_
- [wemake-django-template](https://github.com/wemake-services/wemake-django-template/) - Bleeding edge Django template focused on code quality and security.
- [django2-project-template](https://github.com/vigo/django2-project-template/) - A quick starter template with PostgreSQL.
- [django-webpack-starter](https://github.com/khadegd/django-webpack-starter) - Django Webpack starter template for using Webpack 4.
- [sos-django-template](https://github.com/erayerdin/sos-django-template) - Django starter template with separate dev and production settings
- [sos-django-template](https://github.com/erayerdin/sos-django-template) - Django starter template with separate dev and production settings.
- [django-docker-heroku-template](https://github.com/bfirsh/django-docker-heroku-template) - A template with Docker, GitHub Actions, and Heroku set up for dev/test/prod, plus various other best practices.
### Open Source Projects
- [Blog app with users and forms](https://github.com/wsvincent/djangoforbeginners/tree/master/ch7-blog-app-with-users/)
- [Newspaper app with custom user model, full user auth](https://github.com/wsvincent/djangoforbeginners/tree/master/ch15-comments)
- [pythonic-news](https://github.com/sebst/pythonic-news) - Hacker News clone
- [pythonic-news](https://github.com/sebst/pythonic-news) - Hacker News clone.
- [Behavior-Driven Development with Aloe](https://github.com/testdrivenio/django-aloe-bdd/)
- [Image Sharing Blog](https://github.com/MeNsaaH/soMedia)
- [Bootcamp: An enterprise social network](https://github.com/vitorfs/bootcamp)
- [Zulip](https://github.com/zulip/zulip/) - Open-source team chat
- [django-oscar]() - E-commerce for Django
- [saleor](https://github.com/mirumee/saleor/) - E-commerce storefront
- [Django-CRM](https://github.com/MicroPyramid/Django-CRM/) - Open Source Python CRM based on Django
- [django-job-portal](https://github.com/manjurulhoque/django-job-portal) - Job portal application using Django
- [Built with Django](https://builtwithdjango.com) - Curated list of awesome Django projects
- [Zulip](https://github.com/zulip/zulip/) - Open-source team chat.
- [saleor](https://github.com/mirumee/saleor/) - E-commerce storefront.
- [Django-CRM](https://github.com/MicroPyramid/Django-CRM/) - Open Source Python CRM based on Django.
- [django-job-portal](https://github.com/manjurulhoque/django-job-portal) - Job portal application using Django.
- [Built with Django](https://builtwithdjango.com) - Curated list of awesome Django projects.
## Django REST Framework
@ -361,8 +359,4 @@ _Wagtail, the powerful CMS for modern websites._
- [Wagtail Source Code](https://github.com/wagtail/wagtail/)
- [awesome-wagtail](https://github.com/springload/awesome-wagtail)
- [This week in Wagtail](https://wagtail.io/this-week-in-wagtail/) - A (most) weekly email with updates from the Wagtail core team.
- [Wagtail Space](https://www.wagtail.space/) - Wagtail CMS events around the world
## License
[![CC0](https://licensebuttons.net/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/)
- [Wagtail Space](https://www.wagtail.space/) - Wagtail CMS events around the world.