{
"info": {
"author": "Sebastien Celles",
"author_email": "s.celles@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 3 - Alpha",
"Environment :: Console",
"Intended Audience :: Developers",
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
"Operating System :: OS Independent",
"Programming Language :: Cython",
"Programming Language :: Python",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3.3",
"Programming Language :: Python :: 3.4",
"Topic :: Office/Business :: Scheduling"
],
"description": "|Latest Version| |Supported Python versions| |Download format| |License|\n|Development Status| |Downloads| |Build Status| |Documentation Status|\n\npyade\n=====\n\nA minimal Python class to use ADE Web API for ADE Planning from\n`Adesoft `__.\n\nThis is an unofficial development. I am in no way related to this\ncompany. Use it at your own risk.\n\nWORK IN PROGRESS\n\nUsage\n-----\n\nCommand Line Interface script\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou might first define 3 environment variables.\n\n::\n\n export ADE_WEB_API_URL=\"https://server/jsp/webapi\"\n export ADE_WEB_API_LOGIN=\"user_login\"\n export ADE_WEB_API_PASSWORD=\"user_password\" \n\nThan you can run sample using:\n\n::\n\n $ python sample/main.py\n\nYou can also pass url, login, password as optional parameters of command\nline interface using:\n\n::\n\n $ python sample/main.py --url https://server/jsp/webapi --user user_login --password user_password\n\nInteractive usage\n~~~~~~~~~~~~~~~~~\n\nRun IPython using:\n\n::\n\n $ ipython\n\nYou can use interactively this class\n\n::\n\n In [1]: from pyade import ADEWebAPI, Config\n\nImport logging module and set level to ``logging.DEBUG``\n\n::\n\n In [2]: import logging\n In [3]: logging.basicConfig(level=logging.DEBUG)\n\nGet a config (etiher from environment variables)\n\n::\n\n In [4]: config = Config.create()\n\nor passing parameter to ``Config.create`` method\n\n::\n\n In [4]: config = Config.create(url='server', login='user_login', password='user_password')\n\nYou can safely display config in a console, your password will not\nappear.\n\n::\n\n In [5]: config\n Out[5]:\n \n\nBut you can access to any key like a dict. For example:\n\n::\n\n In [6]: config['url']\n Out[6]: 'https://server/jsp/webapi'\n\nSo caution, your password is not in a safe place, as it's in memory.\n\nConfig can be unpacked using ``**`` operator and use as parameter for\n``ADEWebAPI`` constructor.\n\n::\n\n In [7]: myade = ADEWebAPI(**config)\n\nYou can display methods of ADEWebAPI using \".\" and tab key\n\n::\n\n In [8]: myade.\n myade.connect myade.getActivities myade.getProjects myade.opt_params\n myade.create_list_of_objects myade.getCaracteristics myade.getResources myade.password\n myade.disconnect myade.getCosts myade.hide_dict_values myade.sessionId\n myade.exception_factory myade.getDate myade.logger myade.setProject\n myade.factory myade.getEvents myade.login myade.url\n\nMethod signature, docstring, ... can be printed using \"?\"\n\n::\n\n In [8]: ?myade.connect\n Signature: myade.connect()\n Docstring: Connect to server\n File: ~/pyade/pyade/__init__.py\n Type: instancemethod\n\nLet's connect to server (using url, login and password saved in\n``myade`` instance of ``ADEWebAPI``)\n\n::\n\n In [9]: myade.connect()\n DEBUG:ADEWebAPI:send {'function': 'connect', 'login': 'user_login', 'password': '*********', 'sessionId': '14cef8679e2'}\n INFO:requests.packages.urllib3.connectionpool:Starting new HTTPS connection (1): server\n DEBUG:requests.packages.urllib3.connectionpool:\"GET /jsp/webapi?function=connect&login=user_login&password=user_password&sessionId=14cef8679e2 HTTP/1.1\" 200 None\n DEBUG:ADEWebAPI:\n DEBUG:ADEWebAPI:\n \n\n Out[9]: True\n\nA list of dict describing projects can be returned using:\n\n::\n\n In [10]: myade.getProjects()\n DEBUG:ADEWebAPI:send {'function': 'getProjects', 'sessionId': '14cef8679e2'}\n INFO:requests.packages.urllib3.connectionpool:Starting new HTTPS connection (1): server\n DEBUG:requests.packages.urllib3.connectionpool:\"GET /jsp/webapi?function=getProjects&sessionId=14cef8679e2 HTTP/1.1\" 200 None\n DEBUG:ADEWebAPI:\n DEBUG:ADEWebAPI:\n \n \n \n \n\n Out[10]: [{'id': '6'}, {'id': '5'}]\n\nYou can also use optional parameters such as ``detail`` to get more\ndetails about each project.\n\n::\n\n In [11]: myade.getProjects(detail=4)\n DEBUG:ADEWebAPI:send {'function': 'getProjects', 'sessionId': '14cef8679e2', 'detail': 4}\n INFO:requests.packages.urllib3.connectionpool:Starting new HTTPS connection (1): server\n DEBUG:requests.packages.urllib3.connectionpool:\"GET /jsp/webapi?function=getProjects&sessionId=14cef8679e2&detail=4 HTTP/1.1\" 200 None\n DEBUG:ADEWebAPI:\n DEBUG:ADEWebAPI:\n \n \n \n \n\n Out[11]:\n [{'id': '6',\n 'loaded': 'true',\n 'name': '2015-2016',\n 'uid': '1428406688761',\n 'version': '600'},\n {'id': '5',\n 'loaded': 'true',\n 'name': '2014-2015',\n 'uid': '1364884711514',\n 'version': '520'}]\n\nYou can set ``myade`` instance of class ``ADEWebAPI`` in order methods\noutput list of objects instead of list of dictionaries\n\n::\n\n In [12]: myade.create_list_of_objects(True)\n\n In [13]: myade.getProjects()\n DEBUG:ADEWebAPI:send {'function': 'getProjects', 'sessionId': '14cef8679e2'}\n INFO:requests.packages.urllib3.connectionpool:Starting new HTTPS connection (1): server\n DEBUG:requests.packages.urllib3.connectionpool:\"GET /jsp/webapi?function=getProjects&sessionId=14cef8679e2 HTTP/1.1\" 200 None\n DEBUG:ADEWebAPI:\n DEBUG:ADEWebAPI:\n \n \n \n \n\n Out[13]:\n [Project({'id': '6'}),\n Project({'id': '5'})]\n\nYou need to set current project. You probably won't be able to call most\nof methods without this.\n\n::\n\n In [14]: myade.setProject(5)\n Out[14]: True\n\n...\n\nDon't forget to disconnect from server before quitting.\n\n::\n\n In [15]: myade.disconnect()\n DEBUG:ADEWebAPI:send {'function': 'disconnect', 'sessionId': '14cef8679e2'}\n INFO:requests.packages.urllib3.connectionpool:Starting new HTTPS connection (1): server\n DEBUG:requests.packages.urllib3.connectionpool:\"GET /jsp/webapi?function=disconnect&sessionId=14cef8679e2 HTTP/1.1\" 200 None\n DEBUG:ADEWebAPI:\n DEBUG:ADEWebAPI:\n \n\n Out[15]: True\n\n.. |Latest Version| image:: https://pypip.in/version/pyade/badge.svg\n :target: https://pypi.python.org/pypi/pyade/\n.. |Supported Python versions| image:: https://pypip.in/py_versions/pyade/badge.svg\n :target: https://pypi.python.org/pypi/pyade/\n.. |Download format| image:: https://pypip.in/format/pyade/badge.svg\n :target: https://pypi.python.org/pypi/pyade/\n.. |License| image:: https://pypip.in/license/pyade/badge.svg\n :target: https://pypi.python.org/pypi/pyade/\n.. |Development Status| image:: https://pypip.in/status/pyade/badge.svg\n :target: https://pypi.python.org/pypi/pyade/\n.. |Downloads| image:: https://pypip.in/download/pyade/badge.svg\n :target: https://pypi.python.org/pypi/pyade/\n.. |Build Status| image:: https://travis-ci.org/scls19fr/pyade.svg\n :target: https://travis-ci.org/scls19fr/pyade\n.. |Documentation Status| image:: https://readthedocs.org/projects/pyade/badge/?version=latest\n :target: http://pyade.readthedocs.org/en/latest/",
"description_content_type": null,
"docs_url": null,
"download_url": "UNKNOWN",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/scls19fr/pyade",
"keywords": "python ade client web api schedule scheduling software",
"license": "GPL v3",
"maintainer": null,
"maintainer_email": null,
"name": "pyade",
"package_url": "https://pypi.org/project/pyade/",
"platform": "UNKNOWN",
"project_url": "https://pypi.org/project/pyade/",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "https://github.com/scls19fr/pyade"
},
"release_url": "https://pypi.org/project/pyade/0.0.2/",
"requires_dist": null,
"requires_python": null,
"summary": "Python client for ADE web API",
"version": "0.0.2"
},
"last_serial": 1520765,
"releases": {
"0.0.1": [
{
"comment_text": "",
"digests": {
"md5": "a5db3cf6aa01c1973e6b65f7dd78eaa3",
"sha256": "fa757a4f6ecd62fe43f06295596c05947d2b324b93bdbd820c35ec513a87f55d"
},
"downloads": -1,
"filename": "pyade-0.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a5db3cf6aa01c1973e6b65f7dd78eaa3",
"packagetype": "bdist_wheel",
"python_version": "2.7",
"requires_python": null,
"size": 11376,
"upload_time": "2015-04-25T12:51:34",
"url": "https://files.pythonhosted.org/packages/8f/fa/1ce9bfe7a7bdbda70dbaa6bf5a3f94d4e15f34f8330ee0c0032fad631624/pyade-0.0.1-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "7f76b5d9d831ce8594f35469709d5b66",
"sha256": "4528f476c654e3c003504d50532dd3b95e5b52f604dfa862c314e2b400fedf9f"
},
"downloads": -1,
"filename": "pyade-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "7f76b5d9d831ce8594f35469709d5b66",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8477,
"upload_time": "2015-04-25T12:51:31",
"url": "https://files.pythonhosted.org/packages/d2/6a/17775232d024a32e88c73fe4e0b18a6f74535bbbab620c538bcf01e4b2ae/pyade-0.0.1.tar.gz"
}
],
"0.0.2": [
{
"comment_text": "",
"digests": {
"md5": "da7242cd2040784bbe5aeced61434565",
"sha256": "7805c6fac912af5c5b3ad69ea68b3a303a7e57bade90558dcfb4e28b43e8cbd2"
},
"downloads": -1,
"filename": "pyade-0.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "da7242cd2040784bbe5aeced61434565",
"packagetype": "bdist_wheel",
"python_version": "2.7",
"requires_python": null,
"size": 12206,
"upload_time": "2015-04-25T14:01:22",
"url": "https://files.pythonhosted.org/packages/ed/b8/d8cc372660c178fb15d66c0e1920078ce451f66c13ecc05a492e2f4db9a8/pyade-0.0.2-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "565b7ed683500e9552d305bfd6b55951",
"sha256": "31302541fa80abb850c3b4c378d25d47a90fb2cfdc8176321f1ea4231d0d6cb4"
},
"downloads": -1,
"filename": "pyade-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "565b7ed683500e9552d305bfd6b55951",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10811,
"upload_time": "2015-04-25T14:01:19",
"url": "https://files.pythonhosted.org/packages/5c/a0/797c7a8947fd51c5ea9c5e7297dc246f6f6d3f0b3d1348d840302654123f/pyade-0.0.2.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "da7242cd2040784bbe5aeced61434565",
"sha256": "7805c6fac912af5c5b3ad69ea68b3a303a7e57bade90558dcfb4e28b43e8cbd2"
},
"downloads": -1,
"filename": "pyade-0.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "da7242cd2040784bbe5aeced61434565",
"packagetype": "bdist_wheel",
"python_version": "2.7",
"requires_python": null,
"size": 12206,
"upload_time": "2015-04-25T14:01:22",
"url": "https://files.pythonhosted.org/packages/ed/b8/d8cc372660c178fb15d66c0e1920078ce451f66c13ecc05a492e2f4db9a8/pyade-0.0.2-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "565b7ed683500e9552d305bfd6b55951",
"sha256": "31302541fa80abb850c3b4c378d25d47a90fb2cfdc8176321f1ea4231d0d6cb4"
},
"downloads": -1,
"filename": "pyade-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "565b7ed683500e9552d305bfd6b55951",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10811,
"upload_time": "2015-04-25T14:01:19",
"url": "https://files.pythonhosted.org/packages/5c/a0/797c7a8947fd51c5ea9c5e7297dc246f6f6d3f0b3d1348d840302654123f/pyade-0.0.2.tar.gz"
}
]
}