{ "info": { "author": "Lu\u00eds Maia", "author_email": "luis.maia@xfel.eu", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Scientific/Engineering :: Information Analysis", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "Calibration Client\n==================\n\nDependency responsible for encapsulating and managing the interaction with the\nCalibration Constants Catalogue Web Application throw RESTful API calls.\n\n**Repository:**\n\n * https://git.xfel.eu/gitlab/ITDM/calibration_client\n\n*Dependencies:*\n\n- oauthlib (https://pypi.python.org/pypi/oauthlib)\n- requests (https://github.com/kennethreitz/requests)\n- requests-oauthlib (https://github.com/requests/requests-oauthlib)\n- oauth2_xfel_client (https://git.xfel.eu/gitlab/ITDM/oauth2_xfel_client)\n\n\nInstallation\n------------\n\nPython project\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n1. Install requirements, if never done before\n\n 1.1. For OS X distributions::\n\n sudo port install python35\n sudo port\n\n sudo port select --set python3 python35\n\n sudo port install py35-pip\n sudo port select --set pip pip35\n\n sudo port install py35-nose\n sudo port select --set nosetests nosetests-3.5\n\n pip install pycodestyle\n\n 1.2. For Linux distributions::\n\n sudo apt-get update\n sudo apt-get install python3.5\n\n2. Make calibration_client library available in your python environment\n\n 2.1. Install it via pip::\n\n # Install dependencies from local wheels files\n pip install --no-index --upgrade --find-links ./external_dependencies/*\n\n # Install dependencies from the pypi\n pip install -r requirements.txt\n\n Or as a normal python project (via .egg file)::\n\n python setup.py install\n python setup.py install --user\n\n Running this command the \"compiled\" `calibration_client-6.1.3-py3.4.egg` file\n is generated under the current Python installation site-packages folder.\n\n 2.2. Install it as a normal python project (via Wheel)::\n\n python setup.py bdist_wheel\n\n Running this command 2 folders are generated under the current Python\n installation site-packages folder:\n\n - `calibration_client` with the sources;\n - `calibration_client-6.1.3.dist-info/` with Wheels configuration files.\n\n3. To identify your Python site-packages folder run::\n\n python -c \"from distutils.sysconfig import get_python_lib; print(get_python_lib())\"\n\n\nUsage\n-----\n\nTo use this project you need to import it.\n\nIf you want interact directly with API methods you should import `CalibrationClientApi` class:\n ``from calibration_client.calibration_client_api import CalibrationClientApi``\n\nIf you want interact with Model classes you should import `CalibrationClient` class:\n ``from calibration_client.calibration_client import CalibrationClient``\n\nOr import everything:\n ``import calibration_client``\n\n\nDevelopment & Testing\n---------------------\n\nWhen developing, and before commit changes, please validate that:\n\n1. All tests continue passing successfully (to validate that run *nosetests*)::\n\n # Go to the source code directory\n cd calibration_client\n\n # Run all tests\n nosetests .\n\n # Run all tests and get information about coverage for all files inside calibration_client package\n pip install python-dateutil\n pip install nose-cov\n nosetests --with-cov --cover-erase --cover-inclusive --cov-report term-missing --cov calibration_client\n\n # Run all tests with xunit\n nosetests --where=./calibration_client/ --with-xunit --xunit-file=pythonTest.xml\n\n # If you don't want use nosetests you can simply run the test class\n python -m calibration_client.tests.modules.calibration_constant_version\n\n2. Code keeps respecting pycodestyle code conventions (to validate that run **pycodestyle**)::\n\n pycodestyle .\n\n3. To generate all the wheels files for the dependencies, execute::\n\n # Generate Wheels to its dependencies\n pip wheel --wheel-dir=./external_dependencies -r requirements.txt\n pip wheel --wheel-dir=./external_dependencies --find-links=./external_dependencies -r requirements.txt\n\n # Generate Wheels to itself and dependencies\n pip wheel --wheel-dir=./external_dependencies .\n pip wheel --wheel-dir=./external_dependencies --find-links=./external_dependencies .\n\nGuarantee that you have the desired versions in requirements.txt and setup.py files.\n\n\nRegistering library on https://pypi.org\n---------------------------------------\n\nTo register this python library, the following steps are necessary::\n\n # Install twine\n python -m pip install --upgrade twine\n\n # Generates egg file in the dist/ folder\n python setup.py install\n\n # Upload new version\n twine upload dist/*\n\n # In case a teste is necessary, it is possible to test it against test.pypi.org\n twine upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://git.xfel.eu/gitlab/ITDM/calibration_client", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "calibration-client", "package_url": "https://pypi.org/project/calibration-client/", "platform": "any", "project_url": "https://pypi.org/project/calibration-client/", "project_urls": { "Homepage": "https://git.xfel.eu/gitlab/ITDM/calibration_client" }, "release_url": "https://pypi.org/project/calibration-client/6.1.3/", "requires_dist": null, "requires_python": "", "summary": "Python Client for European XFEL Calibration Catalogue Web App available at https://in.xfel.eu/calibration", "version": "6.1.3" }, "last_serial": 5717386, "releases": { "6.1.3": [ { "comment_text": "", "digests": { "md5": "7625ef6ee23ae1fa0cc4ed52df34e676", "sha256": "13c57ae12f7ce020561505f276847c6aaa7f6b8cae20cd6dca4d65c49f8bd05b" }, "downloads": -1, "filename": "calibration_client-6.1.3-py3.6.egg", "has_sig": false, "md5_digest": "7625ef6ee23ae1fa0cc4ed52df34e676", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 149309, "upload_time": "2019-08-22T06:22:51", "url": "https://files.pythonhosted.org/packages/4e/3b/12c595e94424252e16caae0ae57a2252139de0160a562fe3429f197da9ab/calibration_client-6.1.3-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "954e577b0764871bd3db3ef205cdd0b4", "sha256": "a4c8810af9cf483094ad010fa0ce36a9459ff85522a374bd7b0569040f9627bf" }, "downloads": -1, "filename": "calibration_client-6.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "954e577b0764871bd3db3ef205cdd0b4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 68015, "upload_time": "2019-08-22T21:07:15", "url": "https://files.pythonhosted.org/packages/c4/ea/36aa343d8f594a3c6ed30b83529e8ebca0acadcc0317ec8e105f133d25ee/calibration_client-6.1.3-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7625ef6ee23ae1fa0cc4ed52df34e676", "sha256": "13c57ae12f7ce020561505f276847c6aaa7f6b8cae20cd6dca4d65c49f8bd05b" }, "downloads": -1, "filename": "calibration_client-6.1.3-py3.6.egg", "has_sig": false, "md5_digest": "7625ef6ee23ae1fa0cc4ed52df34e676", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 149309, "upload_time": "2019-08-22T06:22:51", "url": "https://files.pythonhosted.org/packages/4e/3b/12c595e94424252e16caae0ae57a2252139de0160a562fe3429f197da9ab/calibration_client-6.1.3-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "954e577b0764871bd3db3ef205cdd0b4", "sha256": "a4c8810af9cf483094ad010fa0ce36a9459ff85522a374bd7b0569040f9627bf" }, "downloads": -1, "filename": "calibration_client-6.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "954e577b0764871bd3db3ef205cdd0b4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 68015, "upload_time": "2019-08-22T21:07:15", "url": "https://files.pythonhosted.org/packages/c4/ea/36aa343d8f594a3c6ed30b83529e8ebca0acadcc0317ec8e105f133d25ee/calibration_client-6.1.3-py3-none-any.whl" } ] }