docspec

Name	docspec JSON
Version	2.2.1 JSON
	download
home_page	https://github.com/NiklasRosenstein/docspec/
Summary	Docspec is a JSON object specification for representing API documentation of programming languages.
upload_time	2023-05-28 11:24:18
maintainer
docs_url	None
author	Niklas Rosenstein
requires_python	>=3.7,<4.0
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # docspec

This Python packages provides

* A library to (de-) serialize Docspec conformat JSON payloads
* A CLI to validate and introspect such payloads

Example:

```py
import docspec, sys
for module in docspec.load_modules(sys.stdin):
  module.members = [member for member in module.members if member.docstring]
  docspec.dump_module(sys.stdout)
```

```
$ docspec module.json --dump-tree
module docspec
| class Location
| | data filename
| | data lineno
| class Decoration
| | data name
# ...
```

The `docspec` Python module requires Python 3.5 or newer.

---

<p align="center">Copyright &copy; 2020, Niklas Rosenstein</p>


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/NiklasRosenstein/docspec/",
    "name": "docspec",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Niklas Rosenstein",
    "author_email": "rosensteinniklas@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/3c/39/7a71382107445b2cd50c67c6194e3e584f19748a817c3b29e8be8a14f00f/docspec-2.2.1.tar.gz",
    "platform": null,
    "description": "# docspec\n\nThis Python packages provides\n\n* A library to (de-) serialize Docspec conformat JSON payloads\n* A CLI to validate and introspect such payloads\n\nExample:\n\n```py\nimport docspec, sys\nfor module in docspec.load_modules(sys.stdin):\n  module.members = [member for member in module.members if member.docstring]\n  docspec.dump_module(sys.stdout)\n```\n\n```\n$ docspec module.json --dump-tree\nmodule docspec\n| class Location\n| | data filename\n| | data lineno\n| class Decoration\n| | data name\n# ...\n```\n\nThe `docspec` Python module requires Python 3.5 or newer.\n\n---\n\n<p align=\"center\">Copyright &copy; 2020, Niklas Rosenstein</p>\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Docspec is a JSON object specification for representing API documentation of programming languages.",
    "version": "2.2.1",
    "project_urls": {
        "Homepage": "https://github.com/NiklasRosenstein/docspec/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "33aa0c9d71cc9d450afd3993d09835e2910810a45b0703f585e1aee1d9b78969",
                "md5": "b494ae66db3892fe188a1c5ef3a9df60",
                "sha256": "7538f750095a9688c6980ff9a4e029a823a500f64bd00b6b4bdb27951feb31cb"
            },
            "downloads": -1,
            "filename": "docspec-2.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b494ae66db3892fe188a1c5ef3a9df60",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 9844,
            "upload_time": "2023-05-28T11:24:15",
            "upload_time_iso_8601": "2023-05-28T11:24:15.419517Z",
            "url": "https://files.pythonhosted.org/packages/33/aa/0c9d71cc9d450afd3993d09835e2910810a45b0703f585e1aee1d9b78969/docspec-2.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3c397a71382107445b2cd50c67c6194e3e584f19748a817c3b29e8be8a14f00f",
                "md5": "382d0ebbe2e7694e6de59f4b1a691b78",
                "sha256": "4854e77edc0e2de40e785e57e95880f7095a05fe978f8b54cef7a269586e15ff"
            },
            "downloads": -1,
            "filename": "docspec-2.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "382d0ebbe2e7694e6de59f4b1a691b78",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 8646,
            "upload_time": "2023-05-28T11:24:18",
            "upload_time_iso_8601": "2023-05-28T11:24:18.680374Z",
            "url": "https://files.pythonhosted.org/packages/3c/39/7a71382107445b2cd50c67c6194e3e584f19748a817c3b29e8be8a14f00f/docspec-2.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-28 11:24:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NiklasRosenstein",
    "github_project": "docspec",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "docspec"
}