dwitter

Twitter clone based on realpython.com tutorial. The idea is to take a simple tutorial and build from there to customize, try things out, and make it my own.

Tutorial Links

1. Build a Social Network With Django
2. Build a Django Front End With Bulma
3. Build and Handle POST Requests in Django
4. Build and Submit HTML Forms With Django

Additional Resources

• Django User Management
• Django View Authorization
• Documenting Python Code
• Python Type Checking
• Testing in Django Part 1
• Testing in Django Part 2

Custom Enhancements in this Repo vs Tutorial

• Enforced Python coding best practices via protected main branch and a GitHub Workflow:
  • Tests and branching code coverage
  • bandit security scan
  • black formatter
  • isort formatter
  • mypy static typing analysis
  • prospector linting/scanning
  • safety dependency vulnerability scanner
  • tox for multi-python environment testing
• Class based views vs Functional views
• Per-environment settings via environmental variables/.env file with common-sense, secure defaults
• Pagination implemented for dweets/profiles
• Expanded Authentication/Authorization
  • Create profile with email or Google/GitHub OAuth
  • Log In/Log Out/Register pages
• Other small changes here or there I have forgotten

Planned Enhancements

• Dweet/User search
• Documentation using either MkDocs or Sphinx
• Rest API
  • Login/Logout
  • Submit a Dweet
  • Retreive Dweets
  • Dweet/User search
• Light/Dark mode and/or themes
• Docker/Docker-compose support for a more production ready environment
• and more as I think of things

Contributing

I am not accepting contributions at this time, this is primarily just a learning tool and playground for myself.