amyreese / rst2pyi

Convert reStructuredText annotations to PEP 484 type stubs

rst2pyi

Convert reStructuredText annotations to .pyi type stubs

License

rst2pyi is copyright John Reese, and licensed under the MIT license. I am providing code in this repository to you under an open source license. This is my personal repository; the license you receive to my code is from me and not from my employer. See the LICENSE file for details.

rst2pyi's Issues

Achieve 100% test coverage

Currently have no unit tests. We should change that.

Support nested types

rst2pyi does not yet support nested type annotations, such as List[Union[str, int]], specifically when converting from params to imports.

Document basic use cases

The readme is basically empty, we should add some simple usage examples.

Missing files in sdist

Hi @jreese it appears that the manifest is missing at least one file necessary to build from the sdist for version 0.3.0. You're in good company, about 5% of other projects updated in the last year are also missing files.

+ /tmp/venv/bin/pip3 wheel --no-binary rst2pyi -w /tmp/ext rst2pyi==0.3.0
Looking in indexes: http://10.10.0.139:9191/root/pypi/+simple/
Collecting rst2pyi==0.3.0
  Downloading http://10.10.0.139:9191/root/pypi/%2Bf/0f0/dacf579427b9f/rst2pyi-0.3.0.tar.gz (7.7 kB)
    ERROR: Command errored out with exit status 1:
     command: /tmp/venv/bin/python3 -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-wheel-m32i0kwf/rst2pyi/setup.py'"'"'; __file__='"'"'/tmp/pip-wheel-m32i0kwf/rst2pyi/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' egg_info --egg-base /tmp/pip-wheel-m32i0kwf/rst2pyi/pip-egg-info
         cwd: /tmp/pip-wheel-m32i0kwf/rst2pyi/
    Complete output (5 lines):
    Traceback (most recent call last):
      File "<string>", line 1, in <module>
      File "/tmp/pip-wheel-m32i0kwf/rst2pyi/setup.py", line 11, in <module>
        with open("requirements.txt") as f:
    FileNotFoundError: [Errno 2] No such file or directory: 'requirements.txt'
    ----------------------------------------
ERROR: Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output.