ctypeslib icon indicating copy to clipboard operation
ctypeslib copied to clipboard

Better documentation for clang2py

Open trolldbois opened this issue 10 years ago • 3 comments

Create a better documentation, examples and list usage for all arguments on the command line

trolldbois avatar Jan 28 '15 02:01 trolldbois

this is a good template with almost everything already pre-configured: https://github.com/audreyr/cookiecutter-pypackage

luzfcb avatar Jan 28 '15 02:01 luzfcb

There is a start here https://github.com/trolldbois/ctypeslib/blob/master/docs/ctypeslib%202.0%20Introduction.ipynb

trolldbois avatar May 13 '15 23:05 trolldbois

It would be good examples of how to use (or not use) the clang2py command line args.

Some automatic tests to clang2py command line would also be good.

I said that, I was looking at how to do this. argparse seems particularly annoying with automatic tests. the only good library for processing command line arguments (that I know) that has some tools for testing cli is the Click ( https://github.com/mitsuhiko/click )

Click + py.test is great.

I have seen it being used successfully in cookiecutter, see cli.py and test_cli.py

thank you for your hard work. This project is interesting, although I still do not know how to use it properly.

luzfcb avatar May 20 '15 23:05 luzfcb