write

LICENSE.md

@@ -0,0 +1,19 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+Copyright 2023 Ansys Inc

README.md

@@ -0,0 +1,31 @@
+# clr-stubs
+
+Python stub generation system for .NET assemblies, using pythonnet
+These stubs are intended to be used by the autocomplete engine of editors like Atom, Sublime, and VSCode, as well
+as for python documentation generation (e.g. with Sphinx)
+
+## Why clr-stubs?
+
+If your are writing python code using .NET modules via pythonnet's `clr.AddReference`, your IDE's
+autocomplete (which usually runs python) will not be able to follow any .NET namespaces or libraries.
+
+The workaround in clr-stubs is to create 'stubs' or 'fakes' with the same namespaces, types, and metadata
+that would typically be available in a pure python library. The 'stubs' can then be used by your IDE's
+autocomplete.
+
+
+-----------------------
+
+# Documentation
+
+TODO
+
+# Quickstart
+
+TODO
+
+
+### Credits
+
+This project is inspired by [ironpython-stubs](https://github.com/gtalarico/ironpython-stubs) but is developed
+from scratch

TODO.md

@@ -1,8 +1,11 @@
 
 more DLLs
-argparse
 handle subclasses
 sphinx doc build
 vscode autocomplete
 filter in sphinx build instead of doc gen
+split into two libs:
+1. lib to generate stubs (propose to add to pythonnet)
+2. command line program to run mechanical generation system
+