Discussion: v1.0.0 target

TODO — Required

• Timezone support (#103)
• Ensure generate_schema EXACTLY the same as SHOW CREATE TABLE in MySQL (#237)
• Good aggregate/filter support (#309, #257)
• Formal custom select with SQL param placeholder management (#297 #139)

TODO — Nice to have

• MySQL schema generation to be exact (#237)
• Change to all-parametrized queries (#81 #151)
• Common framework samples/integration:
  • aiohttp
  • sanic
  • starlette
  • quart (#119 #121)
  • tornado (#99)
  • fastapi (#188) — starlette + pydantic
• Documentation: (see https://realpython.com/documenting-python-code/#documenting-your-python-projects)
  • Provide concrete examples of what tortoise improves on (#131)
  • Policy re extra DB backends (#31)
  • Document app concept
  • Document Filters
  • Document Aggregate Functions (#3)
• Complete Testing:
  • Test Q (filter, not-Q, bad-Q)
  • Test values() & values_list() (with relation, multi-key)
  • Test sorting/filtering of M2M relation

Done

• Add BinaryField type
• Fields Schema generation refactoring (#97, #206)
  • Ability to map ALL field types to custom DB table/field names. (#55)
  • Schema discovery (#39) (mostly done already, look at #94)
• ~Add OneToOneField (#236)~
• ~Transaction Isolation (#140, #234)~
  • ~Fix DB pools (#69, #229)~
• ~MySQL (#37)~
• ~Tortoise.init() refactor (#14 #29)~
• ~JSONField (#20)~
• ~Test framework overhaul (#29 #33)~
• ~Better transaction support (#29 #33)~
• ~Add Python3.7 to CI when PyLint>=2 goes stable (#28)~
• ~Reusable Test framework (#59)~
• ~Un-transactioned isolation (#110 #111)~
• ~Clean up Tortoise exception structures (#24)~
  • ~Replace assert and AssertionError with appropriate Tortoise exception. (#24)~
  • ~Formalise exception inheritance (#24)~
• ~Cleanup of “Issues” and “Projects”~
• ~Tortoise Organisation in github~
• ~Simple https://tortoise.github.io/ landing page~
• ~Generic PK field that references real PK field (#36 #122)~
• ~Add description on field (#124)~
• ~Python 3.7 support (#22)~
  • ~Fix pylint/astroid >= 2 (#23)~
• Testing:
  • ~Test all data fields (#20)~
  • ~Test .values() and .values_list() (#20)~
  • ~Test transactions (#29 #33)~
  • ~Filter tests for data fields (#44)~
  • ~Test all relation fields (#101)~
  • ~Filter tests for relation fields (#101)~
  • ~Test all Model methods (#34)~
  • ~Test all QuerySet methods (#25)~
  • ~Test the test classes (#25)~
  • ~Test the db_url resolver (#25)~
  • ~Test init (#35)~
  • ~Test connection resiliency (e.g. stale connections, db restarts, etc…)~
• Documentation:
  • ~Document init/config (#35)~
  • ~Document DB_URL (#35)~
  • ~Marketing material~
  • ~Contribution guide~
  • ~Expand documentation re Fields (#25)~
  • ~Expand documentation re Querysets (#25)~
  • ~Expand documentation re Filtering~
  • ~Expand documentation re Exceptions (#25)~
  • ~Expand documentation re Database backends~
  • ~Expand documentation re Models~
  • ~Update README with travis/coveralls badges (#24)~
  • ~Document usage of Model~
  • ~Document Tortoise singleton~
  • ~Document introspection _meta~
  • ~Cleaned up examples~

[csrftoken]

I really want to help you, but I still feel there are some deficiencies in my ability. I will try my best。 Thanks!

[abondar]

Wrote it down in #97