fastapi-openapi-generator


Namefastapi-openapi-generator JSON
Version 0.1.4 PyPI version JSON
download
home_pagehttps://github.com/KiraPC/fastapi-openapi-generator
SummaryA Command Line Interface to save openapi file from a FastAPI application
upload_time2021-02-23 17:56:47
maintainer
docs_urlNone
authorPasquale Carmine Carbone
requires_python>=3.0
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ### What this repository contains

A Command Line Interface to save openapi file from a FastAPI application

### Installation: 

install the package
```
pip install fastapi-openapi-generator
```

### How to use
```
fastapi-openapi-gen main:app \
    --app-dir= # The path to mounth in the python path to import the module. \
    --output-dir= # The path where store the openapi template. \
    --file-name= # The name the openapi file will assume.
    --mock-class= # Use it to mock a package that is not usefully for the openapi generation and block the fastapi start
```
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/KiraPC/fastapi-openapi-generator",
    "name": "fastapi-openapi-generator",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Pasquale Carmine Carbone",
    "author_email": "pasqualecarmine.carbone@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/74/0a/530773ac4d7c1596db95b1897b94aa21a70b540e63b296a324621bdd6ee2/fastapi-openapi-generator-0.1.4.tar.gz",
    "platform": "",
    "description": "### What this repository contains\n\nA Command Line Interface to save openapi file from a FastAPI application\n\n### Installation: \n\ninstall the package\n```\npip install fastapi-openapi-generator\n```\n\n### How to use\n```\nfastapi-openapi-gen main:app \\\n    --app-dir= # The path to mounth in the python path to import the module. \\\n    --output-dir= # The path where store the openapi template. \\\n    --file-name= # The name the openapi file will assume.\n    --mock-class= # Use it to mock a package that is not usefully for the openapi generation and block the fastapi start\n```",
    "bugtrack_url": null,
    "license": "",
    "summary": "A Command Line Interface to save openapi file from a FastAPI application",
    "version": "0.1.4",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "cd45eb014169cba71e03fb0cd7d444c0",
                "sha256": "d094929abe09a0d734ad7f93361ee801f20673846581df378382064085824331"
            },
            "downloads": -1,
            "filename": "fastapi-openapi-generator-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "cd45eb014169cba71e03fb0cd7d444c0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.0",
            "size": 2432,
            "upload_time": "2021-02-23T17:56:47",
            "upload_time_iso_8601": "2021-02-23T17:56:47.411433Z",
            "url": "https://files.pythonhosted.org/packages/74/0a/530773ac4d7c1596db95b1897b94aa21a70b540e63b296a324621bdd6ee2/fastapi-openapi-generator-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-02-23 17:56:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "KiraPC",
    "error": "Could not fetch GitHub repository",
    "lcname": "fastapi-openapi-generator"
}
        
Elapsed time: 0.20218s