stubdocs

Name	stubdocs JSON
Version	0.0.0 JSON
	download
home_page	https://github.com/tusharsadhwani/stubdocs
Summary	Adds docstrings to your type stubs.
upload_time	2023-03-20 07:24:37
maintainer
docs_url	None
author	Tushar Sadhwani
requires_python	>=3.7
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # stubdocs

Adds docstrings to your type stubs.

## Installation

```bash
pip install stubdocs
```

## Usage

```console
$ stubdocs . --stub-dir stubs
rewrote stub stubs/mypackage/foo.pyi using docstrings in mypackage/foo.py
rewrote stub stubs/mypackage/bar/baz.pyi using docstrings in mypackage/bar/baz.py
```

## Local Development / Testing

- Create and activate a virtual environment
- Run `pip install -r requirements-dev.txt` to do an editable install
- Run `pytest` to run tests

## Type Checking

Run `mypy .`

## Create and upload a package to PyPI

Make sure to bump the version in `setup.cfg`.

Then run the following commands:

```bash
rm -rf build dist
python setup.py sdist bdist_wheel
```

Then upload it to PyPI using [twine](https://twine.readthedocs.io/en/latest/#installation):

```bash
twine upload dist/*
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/tusharsadhwani/stubdocs",
    "name": "stubdocs",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Tushar Sadhwani",
    "author_email": "tushar.sadhwani000@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/97/cb/d2183e309ffb1534430be7e9bb353ced1b63bbfecb6a39c73c85a9c2a8bc/stubdocs-0.0.0.tar.gz",
    "platform": null,
    "description": "# stubdocs\n\nAdds docstrings to your type stubs.\n\n## Installation\n\n```bash\npip install stubdocs\n```\n\n## Usage\n\n```console\n$ stubdocs . --stub-dir stubs\nrewrote stub stubs/mypackage/foo.pyi using docstrings in mypackage/foo.py\nrewrote stub stubs/mypackage/bar/baz.pyi using docstrings in mypackage/bar/baz.py\n```\n\n## Local Development / Testing\n\n- Create and activate a virtual environment\n- Run `pip install -r requirements-dev.txt` to do an editable install\n- Run `pytest` to run tests\n\n## Type Checking\n\nRun `mypy .`\n\n## Create and upload a package to PyPI\n\nMake sure to bump the version in `setup.cfg`.\n\nThen run the following commands:\n\n```bash\nrm -rf build dist\npython setup.py sdist bdist_wheel\n```\n\nThen upload it to PyPI using [twine](https://twine.readthedocs.io/en/latest/#installation):\n\n```bash\ntwine upload dist/*\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Adds docstrings to your type stubs.",
    "version": "0.0.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f3e1b555ded69a8924c1425ec5e414b94c389b468114a8ea5ce39fb6a15ae6b9",
                "md5": "7669b8f76fc4ef6d3bb4e81f4baf4d74",
                "sha256": "fce6ef22b5a7831ee0f77edb9379e7efc4040aa939de88ef0d7996d82449b72e"
            },
            "downloads": -1,
            "filename": "stubdocs-0.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7669b8f76fc4ef6d3bb4e81f4baf4d74",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 3927,
            "upload_time": "2023-03-20T07:24:35",
            "upload_time_iso_8601": "2023-03-20T07:24:35.367368Z",
            "url": "https://files.pythonhosted.org/packages/f3/e1/b555ded69a8924c1425ec5e414b94c389b468114a8ea5ce39fb6a15ae6b9/stubdocs-0.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "97cbd2183e309ffb1534430be7e9bb353ced1b63bbfecb6a39c73c85a9c2a8bc",
                "md5": "764d35f64bfaaa293a427385d74fa809",
                "sha256": "5ef409bc000027c4c282bb4f2a35671c820199a69e85c9b801950622db8e8c4e"
            },
            "downloads": -1,
            "filename": "stubdocs-0.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "764d35f64bfaaa293a427385d74fa809",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 3218,
            "upload_time": "2023-03-20T07:24:37",
            "upload_time_iso_8601": "2023-03-20T07:24:37.330281Z",
            "url": "https://files.pythonhosted.org/packages/97/cb/d2183e309ffb1534430be7e9bb353ced1b63bbfecb6a39c73c85a9c2a8bc/stubdocs-0.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-20 07:24:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "tusharsadhwani",
    "github_project": "stubdocs",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "stubdocs"
}