{ "info": { "author": "Somesh Chaturvedi", "author_email": "somesh.08.96@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# Refget Compliance Suite\n\nRepository for the [refget API](http://samtools.github.io/hts-specs/refget.html) Compliance document and test suite.\n\n## Important URLS\n\n- [Refget specification](http://samtools.github.io/hts-specs/refget.html)\n- [Compliance Document](https://compliancedoc.readthedocs.io/en/latest/)\n- [Compliance utility documentation](https://compliancedoc.readthedocs.io/en/latest/utility/)\n\n## Installing the compliance suite\n\n```bash\npip3 install refget-compliance\n```\n\n## Running the compliance suite\n\nThe following will generate a HTML report for your server and serve said HTML. It will also generate a tarball locally of the report\n\n```bash\nrefget-compliance report -s https://refget.server.com/ --serve\n```\n\nThe following will generate a JSON report of your server:\n\n```bash\nrefget-compliance report -s https://refget.server.com/ --json server.json\n```\n\nSetting `--json -` will have the compliance suite write the JSON to STDOUT.\n\n# Additional components\n\n## Building and uploading the package to PyPI\n\nFirst do your edits, test and update `setup.py` with your new version number. Then run the following and provide your user credentials before doing this. This will upload the compliance suite to the test PyPI server.\n\n```bash\npython3 setup.py sdist bdist_wheel\ntwine upload --repository-url https://test.pypi.org/legacy/ dist/*\n```\n\nAssuming this works then upload to live PyPI and provide your live login details.\n\n```bash\ntwine upload dist/*\n```\n\n## Compliance Documentation\n\nTo generate this documentation locally, follow these steps:\n\n```bash\ngit clone https://github.com/ga4gh/refget-compliance.git\n\ncd refget-compliance\n\npip3 install mkdocs\n\nmkdocs serve\n```\n\n## Compliance Test Suite\n\nCompliance test suite is an API testing suite for refget servers.\n\nTo run the tests, follow these steps:\n\n```bash\ngit clone https://github.com/ga4gh/refget-compliance.git\n\ncd refget-compliance-suite/test_suite\n\npip3 install -r requirements.txt\n```\n\nIf the server to be tested supports circular sequences then run\n\n```bash\npy.test --server --cir\n```\n\nand if it doesn't support circular sequences then run\n\n```bash\npy.test --server \n```\n\nIf the server to be tested supports trunc512 algorithm then run\n\n```bash\npy.test --server --trunc512\n```\n\nand if it doesn't support trunc512 algorithm then run\n\n```bash\npy.test --server \n```\n\nIf the server to be tested redirects success queries then run\n\n```bash\npy.test --server --redir\n```\n\nAnd if it doesn't redirects then run\n\n```bash\npy.test --server \n```\n\nYou can try multiple combinations of these flags as per the server implementation for example\n\n```bash\npy.test --server --cir --trunc512\n\npy.test --server --cir --redir\n\npy.test --server --redir --trunc512\n\npy.test --server --cir --trunc512 --redir\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ga4gh/refget-compliance-suite", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "refget-compliance", "package_url": "https://pypi.org/project/refget-compliance/", "platform": "", "project_url": "https://pypi.org/project/refget-compliance/", "project_urls": { "Homepage": "https://github.com/ga4gh/refget-compliance-suite" }, "release_url": "https://pypi.org/project/refget-compliance/1.2.6/", "requires_dist": [ "requests", "click" ], "requires_python": "", "summary": "A compliance utility reporting system for refget server implementations", "version": "1.2.6" }, "last_serial": 4351203, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "4ad13473bcc1d841a4a34ca1b313f583", "sha256": "cac19632ee5706c6c8c4141cf213cb6532c62d926689a77e098d9a26c9b7277b" }, "downloads": -1, "filename": "refget_compliance-1.0.0-py3.5.egg", "has_sig": false, "md5_digest": "4ad13473bcc1d841a4a34ca1b313f583", "packagetype": "bdist_egg", "python_version": "3.5", "requires_python": null, "size": 229711, "upload_time": "2018-09-28T07:35:19", "url": "https://files.pythonhosted.org/packages/1c/ce/8a13bb6aa6be04764b7c91e8168d6327e84a0abe216da27924329a6d55c4/refget_compliance-1.0.0-py3.5.egg" }, { "comment_text": "", "digests": { "md5": "7dfe80dab52e8f950339173240cba68b", "sha256": "96e092d36fbc5c505bb391c0ee61a3e2507b157a649c8c4c177882929f4bf0f2" }, "downloads": -1, "filename": "refget_compliance-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "7dfe80dab52e8f950339173240cba68b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 211808, "upload_time": "2018-09-28T07:35:16", "url": "https://files.pythonhosted.org/packages/6b/fe/afa0ee2e9c09af4128ef004550a5d0aea713d4e24e6080f372595e13a278/refget_compliance-1.0.0-py3-none-any.whl" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "b5031f5d26352a00c8813edc3fe8a487", "sha256": "80546c45a430011d1c8a26b80672f16dc6a29496f38c0f468e6ccfe354947345" }, "downloads": -1, "filename": "refget_compliance-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "b5031f5d26352a00c8813edc3fe8a487", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 211805, "upload_time": "2018-09-28T09:24:12", "url": "https://files.pythonhosted.org/packages/a5/0f/be40c61390e742034306653db1a456b3efcd6149d4daf9ebdceacce5b78b/refget_compliance-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "da0436f38837679b6697515cad8dae69", "sha256": "0866b6cd54d716bf81d734b692ec8d06306f763fbb7d2d27d15fee1ddefa1455" }, "downloads": -1, "filename": "refget-compliance-1.0.1.tar.gz", "has_sig": false, "md5_digest": "da0436f38837679b6697515cad8dae69", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 204236, "upload_time": "2018-09-28T09:24:14", "url": "https://files.pythonhosted.org/packages/8d/26/01bdefb9b539a36fd84269588de484e9e31aa21ff5e089e217b2e9cb08f4/refget-compliance-1.0.1.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "ab9f7bf320fe9868681fff76493d79bc", "sha256": "d7e01e18261418c1b67f9fcfe273f627045334ca66d985e55fa8fa29a389ff7b" }, "downloads": -1, "filename": "refget_compliance-1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "ab9f7bf320fe9868681fff76493d79bc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 211804, "upload_time": "2018-09-30T16:20:10", "url": "https://files.pythonhosted.org/packages/7e/8b/4026066ef9efa68f16fe02995108e5a32794db1e12eed31fdb4e207162f5/refget_compliance-1.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d72b6d90bb8026bcf8feaef5a4b48147", "sha256": "2bd7da65fa9cb1c524fedff7e54ab25ecfb63f4ad223c6fd8f43a169088e6b71" }, "downloads": -1, "filename": "refget-compliance-1.1.0.tar.gz", "has_sig": false, "md5_digest": "d72b6d90bb8026bcf8feaef5a4b48147", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 204241, "upload_time": "2018-09-30T16:20:13", "url": "https://files.pythonhosted.org/packages/ac/89/f968373fa322d1177f59d44665fefa180ee94b3f27bc8e9a2858e1894286/refget-compliance-1.1.0.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "37cf141c351b60df40b58d27567a73bc", "sha256": "f20b5c7c6e28761d313df7930b8f62d611c19bb6d66e8e99c3282f0a72ef903a" }, "downloads": -1, "filename": "refget_compliance-1.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "37cf141c351b60df40b58d27567a73bc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 211799, "upload_time": "2018-09-30T16:37:41", "url": "https://files.pythonhosted.org/packages/43/1a/aabb2206e4b94e07b0fdc0673be2dc848d1967818f35f78166cca06fa573/refget_compliance-1.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "09acf786169bfff9888ecd67359eaa52", "sha256": "90209805b4e6d7ead4c51ad9324b8e103933326b26d4acf8ef4606294ff79a80" }, "downloads": -1, "filename": "refget-compliance-1.2.0.tar.gz", "has_sig": false, "md5_digest": "09acf786169bfff9888ecd67359eaa52", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 204235, "upload_time": "2018-09-30T16:37:44", "url": "https://files.pythonhosted.org/packages/e3/da/f32f2f7c6ca9d85c979fc91380ccd2e0987a282e752560a42b301c633eda/refget-compliance-1.2.0.tar.gz" } ], "1.2.1": [ { "comment_text": "", "digests": { "md5": "50e4ff497792cea200cf90472dc554f1", "sha256": "84e3d75c4187210c5eceae3ea4e802bf58f67009bee844e91643b6c5a4e49e22" }, "downloads": -1, "filename": "refget_compliance-1.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "50e4ff497792cea200cf90472dc554f1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 211795, "upload_time": "2018-10-01T08:50:29", "url": "https://files.pythonhosted.org/packages/c6/9e/897a99c8fd2e8c9f73e6a32155c5d09bccf49af58befc95f1d2267144eee/refget_compliance-1.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3a80114923c2bb697d4d56675388e7e6", "sha256": "455ca9f855d6f03cb4f7aab27402ac1ac92a5b1e3b626e64bea50a0155337278" }, "downloads": -1, "filename": "refget-compliance-1.2.1.tar.gz", "has_sig": false, "md5_digest": "3a80114923c2bb697d4d56675388e7e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 204288, "upload_time": "2018-10-01T08:50:31", "url": "https://files.pythonhosted.org/packages/d7/79/870208e88e026dd7b2c6daf6a6303a0bb3a372da3add3a78dfc7bd59107f/refget-compliance-1.2.1.tar.gz" } ], "1.2.2": [ { "comment_text": "", "digests": { "md5": "908dacd510b6c045b53ed4e88ee40c63", "sha256": "c7e28deea0fb063f2a63c737a5df341e4d617d735f28dfb3f354031ff4a78707" }, "downloads": -1, "filename": "refget_compliance-1.2.2-py3-none-any.whl", "has_sig": false, "md5_digest": "908dacd510b6c045b53ed4e88ee40c63", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 211800, "upload_time": "2018-10-01T13:31:45", "url": "https://files.pythonhosted.org/packages/b5/34/f00a34633dff50dc7fd65abf0ebce3ea388773960b9be7ac493b58517fa9/refget_compliance-1.2.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "213ec95357c51464881525a7049fdb5d", "sha256": "b5bd3c26a38b6f229805942621bf9a5583580f00c01a04e489b8500043e91991" }, "downloads": -1, "filename": "refget-compliance-1.2.2.tar.gz", "has_sig": false, "md5_digest": "213ec95357c51464881525a7049fdb5d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 204291, "upload_time": "2018-10-01T13:31:46", "url": "https://files.pythonhosted.org/packages/a0/2f/0d60d54cac59be5ebc0d31f1d861d06a7c58e515eb0a08a5456a5d7bebfe/refget-compliance-1.2.2.tar.gz" } ], "1.2.3": [ { "comment_text": "", "digests": { "md5": "01e2d469d693d801aaea925d90c4aefe", "sha256": "1e82f7048fb7a479ab782fb624eb3bfa2e30d01490b946ef1f3b33e371afb0fb" }, "downloads": -1, "filename": "refget_compliance-1.2.3-py3-none-any.whl", "has_sig": false, "md5_digest": "01e2d469d693d801aaea925d90c4aefe", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 211935, "upload_time": "2018-10-01T15:56:03", "url": "https://files.pythonhosted.org/packages/66/33/87454b01fa56eb04b5c091a095b4200f753c270dfd06f560746861d366d6/refget_compliance-1.2.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f1694f90f4899476079e4f97fd779601", "sha256": "290ba475d17b6a4beccb89ce15858672f6acb6989dac64e339bbbe2d713590af" }, "downloads": -1, "filename": "refget-compliance-1.2.3.tar.gz", "has_sig": false, "md5_digest": "f1694f90f4899476079e4f97fd779601", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 204373, "upload_time": "2018-10-01T15:56:05", "url": "https://files.pythonhosted.org/packages/aa/53/c55ac2a762655c13b3c87e04e1324aa3ad1539353e9c775f672179d43ce0/refget-compliance-1.2.3.tar.gz" } ], "1.2.4": [ { "comment_text": "", "digests": { "md5": "0e21b73a51673dd671a70df3ff50ebd6", "sha256": "b67cd6bfa6f2c6c69d21e27fbb3c903ac2e14a78238c0547550e27e75b1d2043" }, "downloads": -1, "filename": "refget_compliance-1.2.4-py3-none-any.whl", "has_sig": false, "md5_digest": "0e21b73a51673dd671a70df3ff50ebd6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 211944, "upload_time": "2018-10-01T16:15:04", "url": "https://files.pythonhosted.org/packages/04/4e/86e11c195bc312b23dd243c7942504cb488ac5a97496dd8de6344dd259f1/refget_compliance-1.2.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6e17c4b9cc4df365ccb4298478818d4f", "sha256": "319387d601194154657236d5667e31d5188f87c31796608451b34341c119e525" }, "downloads": -1, "filename": "refget-compliance-1.2.4.tar.gz", "has_sig": false, "md5_digest": "6e17c4b9cc4df365ccb4298478818d4f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 204372, "upload_time": "2018-10-01T16:15:06", "url": "https://files.pythonhosted.org/packages/f8/38/76756f5c5fb5cc946d81c995904464d31f9db9b08632e865715296e48b6c/refget-compliance-1.2.4.tar.gz" } ], "1.2.5": [ { "comment_text": "", "digests": { "md5": "d04e2e360d4de46a246beb0e2404910e", "sha256": "1ab94af2aaa4ee37f7585cc584a1a13fa9dc8e6f381f9a94a9b850201fa2fe44" }, "downloads": -1, "filename": "refget_compliance-1.2.5-py3.5.egg", "has_sig": false, "md5_digest": "d04e2e360d4de46a246beb0e2404910e", "packagetype": "bdist_egg", "python_version": "3.5", "requires_python": null, "size": 230035, "upload_time": "2018-10-04T07:17:29", "url": "https://files.pythonhosted.org/packages/c4/86/a5060fc29c8236997bf445cb48f7806b6c61350c2c26a013634b3ac35af2/refget_compliance-1.2.5-py3.5.egg" }, { "comment_text": "", "digests": { "md5": "e7ff138f3a3276e945081e630b16fead", "sha256": "29af3ba36cfd890ab8e98af8dd723a4ce9ed26f8223692067d3e2426b93bc168" }, "downloads": -1, "filename": "refget_compliance-1.2.5-py3-none-any.whl", "has_sig": false, "md5_digest": "e7ff138f3a3276e945081e630b16fead", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 212126, "upload_time": "2018-10-04T07:17:26", "url": "https://files.pythonhosted.org/packages/cf/d2/44127e0d7f648f1980663b2f0b64b4333e5c728e8a740cb83fcd1cb35051/refget_compliance-1.2.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1aed3516a9eac8cc5e48ce90792ce340", "sha256": "fcc017fe0d33bde9e688662f0d777b9b2f3ae34419a1bfd3e40b464612a438dc" }, "downloads": -1, "filename": "refget-compliance-1.2.5.tar.gz", "has_sig": false, "md5_digest": "1aed3516a9eac8cc5e48ce90792ce340", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 204413, "upload_time": "2018-10-04T07:17:27", "url": "https://files.pythonhosted.org/packages/37/15/6d641d3ca323f59f78da814c6f5e4affda2bb1139f335f3a90fc500bcd5f/refget-compliance-1.2.5.tar.gz" } ], "1.2.6": [ { "comment_text": "", "digests": { "md5": "9332e40d39bfdf1d668f39f348222cab", "sha256": "baefc223f5a45ec602606c596a9d7459c5ed77ec2284f0285e5320864d2a034f" }, "downloads": -1, "filename": "refget_compliance-1.2.6-py3.5.egg", "has_sig": false, "md5_digest": "9332e40d39bfdf1d668f39f348222cab", "packagetype": "bdist_egg", "python_version": "3.5", "requires_python": null, "size": 230349, "upload_time": "2018-10-08T09:00:16", "url": "https://files.pythonhosted.org/packages/c8/01/b655d0d3d2dc58c3270877e34636a36d8ce8e58832609232c5e0014d4b0d/refget_compliance-1.2.6-py3.5.egg" }, { "comment_text": "", "digests": { "md5": "d5d5878761bdde4b09b29776468ce9f8", "sha256": "fa1403922b26e52d444bc62b9029387894e1b045f22f79bf3573b81d1255090f" }, "downloads": -1, "filename": "refget_compliance-1.2.6-py3-none-any.whl", "has_sig": false, "md5_digest": "d5d5878761bdde4b09b29776468ce9f8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 212187, "upload_time": "2018-10-08T09:00:13", "url": "https://files.pythonhosted.org/packages/7f/46/1739dad985f7f94c520af79103530acd34ee393f109f5beed5a3a43e5e95/refget_compliance-1.2.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2f5f0068c5c5959703c2141073016d87", "sha256": "c787a2c6f435befdb1c06302a0bda17ed07dadd32833d68d8d9779ccf40d7a0c" }, "downloads": -1, "filename": "refget-compliance-1.2.6.tar.gz", "has_sig": false, "md5_digest": "2f5f0068c5c5959703c2141073016d87", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 204488, "upload_time": "2018-10-08T09:00:15", "url": "https://files.pythonhosted.org/packages/f3/d2/c13d36f745f8a58db35ab6c78767d6cc61716851fca40560a82eccdeaffc/refget-compliance-1.2.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9332e40d39bfdf1d668f39f348222cab", "sha256": "baefc223f5a45ec602606c596a9d7459c5ed77ec2284f0285e5320864d2a034f" }, "downloads": -1, "filename": "refget_compliance-1.2.6-py3.5.egg", "has_sig": false, "md5_digest": "9332e40d39bfdf1d668f39f348222cab", "packagetype": "bdist_egg", "python_version": "3.5", "requires_python": null, "size": 230349, "upload_time": "2018-10-08T09:00:16", "url": "https://files.pythonhosted.org/packages/c8/01/b655d0d3d2dc58c3270877e34636a36d8ce8e58832609232c5e0014d4b0d/refget_compliance-1.2.6-py3.5.egg" }, { "comment_text": "", "digests": { "md5": "d5d5878761bdde4b09b29776468ce9f8", "sha256": "fa1403922b26e52d444bc62b9029387894e1b045f22f79bf3573b81d1255090f" }, "downloads": -1, "filename": "refget_compliance-1.2.6-py3-none-any.whl", "has_sig": false, "md5_digest": "d5d5878761bdde4b09b29776468ce9f8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 212187, "upload_time": "2018-10-08T09:00:13", "url": "https://files.pythonhosted.org/packages/7f/46/1739dad985f7f94c520af79103530acd34ee393f109f5beed5a3a43e5e95/refget_compliance-1.2.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2f5f0068c5c5959703c2141073016d87", "sha256": "c787a2c6f435befdb1c06302a0bda17ed07dadd32833d68d8d9779ccf40d7a0c" }, "downloads": -1, "filename": "refget-compliance-1.2.6.tar.gz", "has_sig": false, "md5_digest": "2f5f0068c5c5959703c2141073016d87", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 204488, "upload_time": "2018-10-08T09:00:15", "url": "https://files.pythonhosted.org/packages/f3/d2/c13d36f745f8a58db35ab6c78767d6cc61716851fca40560a82eccdeaffc/refget-compliance-1.2.6.tar.gz" } ] }