AS-Client - Client Library for Analysis Services
# Documentation
Documentation of the client's classes and functions can be generated with
[Doxygen](http://www.stack.nl/~dimitri/doxygen/index.html). The project also
uses [doxypypy](https://github.com/Feneric/doxypypy) - a Python-specific filter
for Doxygen - to allow the documentation to be specified more naturally within
the various Python docstrings throughout the code.
## Tool Installation
Naturally, generating the documentation requires that Doxygen be installed - see
https://www.stack.nl/~dimitri/doxygen/manual/install.html for instructions.
The doxypypy filter is most easily installed using the Python "pip" package
manager (see https://pip.pypa.io/en/stable/installing/ for installation
instructions for pip). With pip installed, simply issue the following
command to install doxypypy (for Unix-like systems):
sudo pip install doxypypy
Unfortunately, Doxygen assumes that filters can be called without supplying any
command-line parameters except for the path of the file to filter.
Unfortunately, doing so with a standard doxypypy installation will omit several
important options. The Doxyfile included with this project addresses this by
instead calling a simple wrapper script `doxypypy.sh` that is included as part
of the project.
## Generating Documentation
To generate the documentation for the client, simply change directory to the
project's root directory (containing the `Doxyfile` file), and issue the
following command:
doxygen Doxyfile
This will process the Python source files, and generate a new `doc` directory
containing the documentation files.
Raw data
{
"_id": null,
"home_page": "https://bitbucket.csiro.au/projects/SC/repos/as-client-python/browse",
"name": "as_client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": null,
"keywords": "Analysis-Services",
"author": "Mac Coombe",
"author_email": "Mac Coombe <mac.coombe@csiro.au>",
"download_url": "https://files.pythonhosted.org/packages/2c/4a/909887130da042be46f793bdff257dd5ecbd43b3c5910390edbb41966933/as_client-2.22.0.tar.gz",
"platform": null,
"description": "\nAS-Client - Client Library for Analysis Services\n\n# Documentation\n\nDocumentation of the client's classes and functions can be generated with\n[Doxygen](http://www.stack.nl/~dimitri/doxygen/index.html). The project also\nuses [doxypypy](https://github.com/Feneric/doxypypy) - a Python-specific filter\nfor Doxygen - to allow the documentation to be specified more naturally within\nthe various Python docstrings throughout the code.\n\n## Tool Installation\n\nNaturally, generating the documentation requires that Doxygen be installed - see\nhttps://www.stack.nl/~dimitri/doxygen/manual/install.html for instructions.\n\nThe doxypypy filter is most easily installed using the Python \"pip\" package\nmanager (see https://pip.pypa.io/en/stable/installing/ for installation\ninstructions for pip). With pip installed, simply issue the following\ncommand to install doxypypy (for Unix-like systems):\n\n sudo pip install doxypypy\n\nUnfortunately, Doxygen assumes that filters can be called without supplying any\ncommand-line parameters except for the path of the file to filter.\nUnfortunately, doing so with a standard doxypypy installation will omit several\nimportant options. The Doxyfile included with this project addresses this by\ninstead calling a simple wrapper script `doxypypy.sh` that is included as part\nof the project.\n\n## Generating Documentation\n\nTo generate the documentation for the client, simply change directory to the\nproject's root directory (containing the `Doxyfile` file), and issue the\nfollowing command:\n\n doxygen Doxyfile\n\nThis will process the Python source files, and generate a new `doc` directory\ncontaining the documentation files.\n",
"bugtrack_url": null,
"license": null,
"summary": "Analysis Services Client",
"version": "2.22.0",
"project_urls": {
"Homepage": "https://bitbucket.csiro.au/projects/SC/repos/as-client-python/browse"
},
"split_keywords": [
"analysis-services"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "60f35243f96b0888d1427a4d20e677b77ce723e89c202dd678ab17e3a32be340",
"md5": "4324c0ac119e6a585b026bd3e314cede",
"sha256": "5efdcda9c5ee60e9d99cb55bb45deb83122570473248e045e4e8abb7db6a5d5e"
},
"downloads": -1,
"filename": "as_client-2.22.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4324c0ac119e6a585b026bd3e314cede",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=2.7",
"size": 22061,
"upload_time": "2024-12-04T05:58:19",
"upload_time_iso_8601": "2024-12-04T05:58:19.928775Z",
"url": "https://files.pythonhosted.org/packages/60/f3/5243f96b0888d1427a4d20e677b77ce723e89c202dd678ab17e3a32be340/as_client-2.22.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2c4a909887130da042be46f793bdff257dd5ecbd43b3c5910390edbb41966933",
"md5": "94e4b00eb1f41683a9ecab50826d40a8",
"sha256": "df8a333b324bfddae164732a2eb8a8f4cbe6054722a93e8a2476454276cdb213"
},
"downloads": -1,
"filename": "as_client-2.22.0.tar.gz",
"has_sig": false,
"md5_digest": "94e4b00eb1f41683a9ecab50826d40a8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 20932,
"upload_time": "2024-12-04T05:58:18",
"upload_time_iso_8601": "2024-12-04T05:58:18.085557Z",
"url": "https://files.pythonhosted.org/packages/2c/4a/909887130da042be46f793bdff257dd5ecbd43b3c5910390edbb41966933/as_client-2.22.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 05:58:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "as_client"
}
JSON