Version 1.0.0 plan

[mjpieters]

This is a meta issue to track what I think would need to happen to get to something that can be called version 1.0:

Development and release process

• Update the testing strategy
  • Use tox to allow developers to run the tests locally against multiple Python versions, Testing against multiple python versions with tox #102
  • Add coverage tracking, e.g. via codecov
  • Clean up the testing strategy, covering components with unittests and providing some integration testing for backends
• Use towncrier to manage the changelog, require changelog entries for PRs: 📣 Start managing the changelog with towncrier #171
  • Include a how-to in contributor-oriented documentation
• Configure dependabot and workflows to manage dependencies, Configure dependabot and associated workflows #160
• Rework workflows to separate linting, testing and integrate releasing to PyPI and GitHub releases when a tag is created, 📦 Move PyPI release workflow into the main workflow. #166
• Set up issue templates for bug reports and feature requests, with a pointer to the discussion forum. The issue templates should collect some minimal info on issues (version, setup, logs, headers).

Documentation

• Create Mkdocs documentation structure
• Create a documentation site (GH pages, RTD, Netlify)
• Stretch goal: automatic preview on PRs that touch documentation.
• Sections to cover:
  • Quickstart
  • Backends, incl custom howto
  • Key generation
  • Coders
  • API documentation
  • Examples
  • Contributing

Architecture

• FastAPICache instances instead of global state, Can't use separate cache configurations in an application #142
• Use annotations to configure cache key generation, Feature Request: use Annotation markers to special-case argument handling #129
• Allow key generator to signal uncacheability, support filter argument in cache decorator #15
• Improve cache control header handling, Improve Cache-Control header parsing and handling #144
• Make more things configurable:
  • Request methods to cache for, Not caching requests except for GET #75
  • HTTP Cache header support (setting response headers, what request headers to honour), Option to not set response header #71, Improve Cache-Control header parsing and handling #144

[mkdir700]

Awesome, guy.

[mgguo]

Look forward to the 1.0 version! Before that, can have a sub 1.0 version as requested in #145 ?

[RomeoAva]

Agreed, would it be possible to get a release to implement fixes? For example we are currently unable to use this for POST endpoints...

Due to: #113

The fix has been implement but not released :(

[ppanchal-mobiz]

Thank you, still looking forward to this one. We see a lot of changes have already been implemented but have not yet been released. Is it possible to do that while we wait for v1.0.0?

[ermiyaeskandary]

+1... can we get an intermediate release please? I would prefer to use an official release as opposed to private forked versions!