wahl-sec / doc-log Goto Github PK

Add support for special typing classes such as Union and Optional.

• Add tests for special types support.
• Implement special types support.
• Update README with support and examples.

Implement support for different logging levels.

• Add tests for logging level.
  • This will be tested in the same way as logging.
• Implement support for logging level.
• Update README with support and examples.

Add coverage reports to tests and potentially add some requirements on coverage for testing in order to pass GitHub actions.

• Add coverage testing for pytest
• Add coverage report collection in GitHub actions
• Add repo badges for coverage and other badges

Add support for building wheels as part of a GitHub actions pipeline and automatically push to package section of GitHub.

• Implement pipeline.
• Update README with support and examples.

Add passive and active type checking for docstrings that can be parsed that include types.

• Add tests for passive type checking.
• Add tests for active type checking.
• Implement passive type checking.
• Implement active type checking.
• Update README with support and examples.

Add support for parsing docstrings of numpydoc format and add tests.

• Add tests for parser.
• Implement parser.
• Update README with support and examples.

• Support arguments that are non-keyword arguments aswell.
• This can be done by guessing argument on order of arguments.
• Would also need to support calls where keyword arguments are mixed with non-keyword arguments.

• Implement tests for non-keyword arguments
• Implement tests for mixed non-keyword arguments and keyword arguments
• Implement support for non-keyword arguments in type checking.
• Update README with support and examples.

Publish the wheels to PyPi either automatically or manually.

• Implement support for PyPi.
• Update README with support and examples.

• Add some example programs showcasing the capabilities.
• Should be larger than the current README examples.

• Add line in source code to function/method when logging for easier debugging.

Add support for logging type checks, called functions/methods.

• Add tests for logging.
  • We can probably test this by outputting logs and comparing to an expected log file.
• Implement logging support.
• Update README with support and examples.