Skip to content

Latest commit

 

History

History
98 lines (81 loc) · 2.08 KB

ROADMAP.md

File metadata and controls

98 lines (81 loc) · 2.08 KB

0.1.0

  • Abstract Architecture
  • Default Driver
  • Command Builder
  • Sphinx Builder
  • NoneEnvironment (doesn't do anything)
  • PIP Environment
  • POETRY Environment
  • GIT Provider
  • Implement API for conf.py
    • Provide data class for use in conf.py
    • Load values

0.2.0

  • Docstrings
  • Venv support
  • Virtualenv support
  • Implement root render
  • Implement API for polyconf.py
    • Override conf values
    • Basic configuration
  • Entry point to run from terminal

0.3.0

  • Fix async file_predicate
  • Fix Poetry env location
  • Register hooks with Encoder

0.4.0

  • Helpers for dynamic build paths and etc.
  • Sort tags
    • by date
    • by name
  • Allow str in addition to Path in commonly used API
  • Extend API for conf.py with quality of life improvements
  • Make VCS provide a namer
  • README

0.5.0

  • Custom data format - depending on version
  • Verbosity flag
  • Pre and post build commands
  • Easily build local version and mocking
  • PyPi package

1.0.0

  • 70% Test coverage
    • Unittests
    • Integration tests
  • Enhance README
    • Comparison to alternatives
  • CI
    • Coverage badge
    • Test badge
    • publish to pypi on release
    • Tests
    • Doc preview
    • Linting
  • Docs on Github Pages

1.0.1

  • Extensive Documentation
    • User guide
      • Use different setups depending on the version
      • Updating docs from old versions using cherry-pick
    • Subclassing guide
    • Reference
      • Command line syntax
      • API
      • Abstract classes
      • Implementations
  • Contributing Standards
    • Contributing
    • Workflows, Policies
    • Maintaining
  • CI
    • Change in coverage
    • Highlight linting problems in PR
    • Higlight uncovered code in PR

1.1.0

  • Caching (e.g. of poetry envs)
  • Only rebuild changed versions
  • Easy integration with ci
  • Github Action
  • Read conf file location from pyproject.toml?

Wishlist

  • typed overrides