{ "info": { "author": "CSG Data Science", "author_email": "csgdatascience01@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 1 - Planning", "Framework :: Flask", "Framework :: Setuptools Plugin", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Topic :: Software Development :: Libraries :: Application Frameworks", "Topic :: Utilities" ], "description": "# DS Platform :: Vulcan\n\n> A tiny python library for expressing data as a resource.\n\n## Installing / Getting started\n\nA quick introduction of the minimal setup you need to get a hello world up &\nrunning.\n\n```shell\npip install CSGVulcan\n```\n\n```python\nfrom CSGVulcan import VulcanResource, VulcanAPI\n\nclass MyNewResource(VulcanResource):\n def __init__(self, resource, name=__file__):\n self.super().__init__(resource, name=name)\n\n def init(self, _context):\n return \"Init\"\n\n def fetch_one(self, _context):\n return \"Fetch One\"\n\n def fetch_all(self, _context):\n return \"Fetch All\"\n\nmy_new_resource = MyNewResource()\nmy_new_resource_api = VulcanAPI(resource=my_new_resource)\n# VulcanAPI.run is a proxy for Flask.run, therefore accepts the same arguments\nmy_new_resource_api.run(port=8080, debug=True)\n```\n\nCSGVulcan will then spin up a Flask Web Server at 127.0.0.1:8080\nwith the following routes available for consumption.\n\n- /api/ping\n- /api/fetch-one\n- /api/fetch-all\n\n### For more detailed examples please see the _examples_ directory\n\n## Developing\n\nIf you're interested in developing and contributing to Vulcan, first, clone this project\nfrom Github. Secondly, set up your local environemnt for develpment. It is recommended to\ncreate a python virtual environment to manage your dependencies, here is how to do\nthat.\n\nCreate and activate your virtualenv.\n\n```shell\npython -m venv venv\n```\n\n```shell\nsource ./venv/bin/activate\n```\n\nPip install the depdencies\n\n```shell\npip install -r requirements.txt\n```\n\n## Features\n\n- Provides a simple and consistent interface for describing data from external resources.\n- Once defined, your VulcanResource is then easily converted into a REST API.\n\n## Contributing\n\nIf you'd like to contribute, please fork the repository and use a feature\nbranch. Pull requests are warmly welcomed.\n\nVulcan is a tool designed to serve others, so any and all feedback is expected and\nencouraged. We aim to create a better pattern for accessing data, if you have ideas, contribute them.\n\n### Styleguide\n\nVulcan is written using autopep8 and pylint, it is recommended to leverage those to allow\nfor consistent styling of source code.\n\n## Links\n\nThough not exhaustive, here is a list of useful links that may help in developing an understanding of Vulcan and what it is comprised of.\n\n- [Flask](http://flask.pocoo.org/)\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": "", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "CSGVulcan", "package_url": "https://pypi.org/project/CSGVulcan/", "platform": "", "project_url": "https://pypi.org/project/CSGVulcan/", "project_urls": null, "release_url": "https://pypi.org/project/CSGVulcan/0.3.2/", "requires_dist": [ "Flask", "Cython", "pandas", "requests" ], "requires_python": "", "summary": "A tiny library for describing data as a resource", "version": "0.3.2" }, "last_serial": 4857327, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "90f4fd125a598f72dad8dde8cc7af5b4", "sha256": "0cf28c4cfae9188d71526ab9474f023eb6230b9b28ff0a5507d5634c565e2d13" }, "downloads": -1, "filename": "CSGVulcan-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "90f4fd125a598f72dad8dde8cc7af5b4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6116, "upload_time": "2019-02-21T16:32:24", "url": "https://files.pythonhosted.org/packages/49/11/8f1ad133563c85661d005c3d56c8fbb6bc9ffa758743b167b97305d0f074/CSGVulcan-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2033bd0f3acef99c524a26fe6f7200e2", "sha256": "6a51aa1c7c93427cf01b27b2eb7b0ae5a794e03175ab6ed53d4cd3f79368333c" }, "downloads": -1, "filename": "CSGVulcan-0.1.0.tar.gz", "has_sig": false, "md5_digest": "2033bd0f3acef99c524a26fe6f7200e2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5745, "upload_time": "2019-02-21T16:32:26", "url": "https://files.pythonhosted.org/packages/2c/3a/7fe7fa4bca52b5226ed4a602fb1391b059b6cb21221aeebec88cb0fac918/CSGVulcan-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "6ef3d4a475cf9235a91eb60e5a93181a", "sha256": "13619b5c1ab4e8904a322302075e24fad5847cd233586dbdb6e526da5f112b87" }, "downloads": -1, "filename": "CSGVulcan-0.1.1.tar.gz", "has_sig": false, "md5_digest": "6ef3d4a475cf9235a91eb60e5a93181a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6461, "upload_time": "2019-02-21T16:50:43", "url": "https://files.pythonhosted.org/packages/a4/68/e426ab09f01602e1453bf435ae9874af7b6f97fdc91ad8c716142b0c774b/CSGVulcan-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "affb8be98ebdc77b1156cfcf66d108ed", "sha256": "b12e02b3dcf5a083d4543c34ea87d48d84059d54f2321f0368fa715238d1efcb" }, "downloads": -1, "filename": "CSGVulcan-0.1.2.tar.gz", "has_sig": false, "md5_digest": "affb8be98ebdc77b1156cfcf66d108ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6458, "upload_time": "2019-02-21T16:51:38", "url": "https://files.pythonhosted.org/packages/58/5a/2ec7c94dc405df54ddc22638300661330180e9e99861fba5b791034cbfc7/CSGVulcan-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "81c5a86087b11431bfc289a0594c583d", "sha256": "2a84de8467b04347485e4910b01e7c68338351a783cd1d9ec754c4344ebc5ce8" }, "downloads": -1, "filename": "CSGVulcan-0.1.3.tar.gz", "has_sig": false, "md5_digest": "81c5a86087b11431bfc289a0594c583d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6452, "upload_time": "2019-02-21T16:52:31", "url": "https://files.pythonhosted.org/packages/3c/4d/a49dd995c5867e5a652394d6a1e40080e518ce4d99d24d38d2ae492bcbf7/CSGVulcan-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "1b48ccbf0121f508483a8d3ad6f8533f", "sha256": "0e57429f0af040ea45a30d322b32cf2d551a1cdfdc43b7cfc7e04420f48727a9" }, "downloads": -1, "filename": "CSGVulcan-0.1.4.tar.gz", "has_sig": false, "md5_digest": "1b48ccbf0121f508483a8d3ad6f8533f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5691, "upload_time": "2019-02-21T16:55:18", "url": "https://files.pythonhosted.org/packages/18/18/b38488bab9936a35a32fc2647a48166bd2ce12f0cf7bbe82a67a4712046d/CSGVulcan-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "0c8a3db6115d97111d7ae7b9a134d88f", "sha256": "8f31911c2c18b062b8599ede055d8cf14a3cfa5a1cacaa7ea20318e0b7d5d3ea" }, "downloads": -1, "filename": "CSGVulcan-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "0c8a3db6115d97111d7ae7b9a134d88f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6050, "upload_time": "2019-02-21T16:58:17", "url": "https://files.pythonhosted.org/packages/bb/3c/cea28a687b7a81983fc180229e2297f31a262656b91b05165c65069a2d2c/CSGVulcan-0.1.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f662489930759f4de730f396b4019541", "sha256": "7888dacd20be7c07caadd14bb8a01abc69cabf3a3c32e5b00813a305c26e1df5" }, "downloads": -1, "filename": "CSGVulcan-0.1.5.tar.gz", "has_sig": false, "md5_digest": "f662489930759f4de730f396b4019541", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5694, "upload_time": "2019-02-21T16:58:19", "url": "https://files.pythonhosted.org/packages/c5/d8/295a0dad8f0b6556f6fe38a406f0af74e380d096912dfe346bdbb8c0fdd4/CSGVulcan-0.1.5.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "070f2f1dfccb6134f00171fba766f3ac", "sha256": "3b46894fa631d9edde987a0c533d052a03a9d2bffaaba4446fcba0bfdf2eb10c" }, "downloads": -1, "filename": "CSGVulcan-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "070f2f1dfccb6134f00171fba766f3ac", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6193, "upload_time": "2019-02-21T17:07:42", "url": "https://files.pythonhosted.org/packages/6b/c5/5f89d698e65a898b596c7e4871ff7b6fcdc2e56cd835e38630ee3c7df3ba/CSGVulcan-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2789b05cb0b22b6ecc84e946bdf4d56f", "sha256": "a14d241cb6bdade6b252dde91c4470fb0c8d38b27eed8e740dca8712a4c11429" }, "downloads": -1, "filename": "CSGVulcan-0.2.0.tar.gz", "has_sig": false, "md5_digest": "2789b05cb0b22b6ecc84e946bdf4d56f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5826, "upload_time": "2019-02-21T17:07:43", "url": "https://files.pythonhosted.org/packages/58/dc/969c6298fc22845c979890413ed7888d0c8a45cda4479556734b43e768f6/CSGVulcan-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "75169ee6136dce9ca1f83e5c20216246", "sha256": "6c63def645af806930790977c0eacc5440175fe906e49f8fa5530e9106659134" }, "downloads": -1, "filename": "CSGVulcan-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "75169ee6136dce9ca1f83e5c20216246", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6217, "upload_time": "2019-02-21T21:58:59", "url": "https://files.pythonhosted.org/packages/dc/2f/95cfa023cc1ffc8c1e2ab218ee032a21d11eb111ece34914d1d690fd9dc2/CSGVulcan-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7714ed987f3aa4853d14c2902e499bea", "sha256": "c36f081fa43fff3cb30d6b02389b6559de158b6610470c82157ff0d3984be9f4" }, "downloads": -1, "filename": "CSGVulcan-0.2.1.tar.gz", "has_sig": false, "md5_digest": "7714ed987f3aa4853d14c2902e499bea", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5855, "upload_time": "2019-02-21T21:59:00", "url": "https://files.pythonhosted.org/packages/19/cb/88d453943868f9f272569f4f8a23ed6892cd1e3770cd07991627f873667c/CSGVulcan-0.2.1.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "b72c22f7fef27f516a638070699dea73", "sha256": "dda3210d10f61e13b2840c0b355de3e911132d3d4073080c3f2dd6a34edbe2ae" }, "downloads": -1, "filename": "CSGVulcan-0.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "b72c22f7fef27f516a638070699dea73", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6493, "upload_time": "2019-02-23T00:35:12", "url": "https://files.pythonhosted.org/packages/97/22/1a1f2e8b5a5010b7844e2562db7484addac0f1db626b908a8104180705e1/CSGVulcan-0.3.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "58fcd4da7f37c58c5d799a1909cd0006", "sha256": "445e4eab7f4ea9351b7bc661402702bb8673b1423eff76da5e6df6a9c807b501" }, "downloads": -1, "filename": "CSGVulcan-0.3.0.tar.gz", "has_sig": false, "md5_digest": "58fcd4da7f37c58c5d799a1909cd0006", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6083, "upload_time": "2019-02-23T00:35:13", "url": "https://files.pythonhosted.org/packages/61/2c/ca12220e27b8eaf528ff5258f47be85e5bfb0a4a255acbb140b6aa05b96c/CSGVulcan-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "4d189bcfecd742ec2444c352ddf4c75d", "sha256": "d3953995b1175d0180e0a21f4ca10a93d7d2b0a410fae18cf45c4d8b2b65fc48" }, "downloads": -1, "filename": "CSGVulcan-0.3.1-py3-none-any.whl", "has_sig": false, "md5_digest": "4d189bcfecd742ec2444c352ddf4c75d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6487, "upload_time": "2019-02-23T04:49:47", "url": "https://files.pythonhosted.org/packages/7c/9b/aabd3eb552ff1119f606009809db0436326f1c56b0df7a0b4f814a456a19/CSGVulcan-0.3.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "72b187852a38b2696567b93e1677f7c5", "sha256": "1582a07de2225c93b226de3a50bb461520130741c8b7dd46be13a4dbefc7651e" }, "downloads": -1, "filename": "CSGVulcan-0.3.1.tar.gz", "has_sig": false, "md5_digest": "72b187852a38b2696567b93e1677f7c5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6083, "upload_time": "2019-02-23T04:49:48", "url": "https://files.pythonhosted.org/packages/1b/95/d74b510e02a00cce63048c82011f23822047ddd58a177341a025cb887938/CSGVulcan-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "71acebc3e290714719ff53a7b98c5ceb", "sha256": "8f9db014e5eb36f17d9e056021743604fd5ac2df2e671feda8e4b8bb7fe0338a" }, "downloads": -1, "filename": "CSGVulcan-0.3.2-py3-none-any.whl", "has_sig": false, "md5_digest": "71acebc3e290714719ff53a7b98c5ceb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6494, "upload_time": "2019-02-23T05:53:18", "url": "https://files.pythonhosted.org/packages/35/f8/f701b6fd0c655825b0344626958065ee729614174761e988415f605f673e/CSGVulcan-0.3.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a6ce15559a38e565500925a768849141", "sha256": "755807e24d31839e1cb624d915010d2741d3daf2aff9b7c0d33b9bcea7a8036f" }, "downloads": -1, "filename": "CSGVulcan-0.3.2.tar.gz", "has_sig": false, "md5_digest": "a6ce15559a38e565500925a768849141", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6092, "upload_time": "2019-02-23T05:53:19", "url": "https://files.pythonhosted.org/packages/c8/5d/5d5ff0dcd7cb0f6bb5149792dde106ee63a62a9fe607deae8466976d3bc3/CSGVulcan-0.3.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "71acebc3e290714719ff53a7b98c5ceb", "sha256": "8f9db014e5eb36f17d9e056021743604fd5ac2df2e671feda8e4b8bb7fe0338a" }, "downloads": -1, "filename": "CSGVulcan-0.3.2-py3-none-any.whl", "has_sig": false, "md5_digest": "71acebc3e290714719ff53a7b98c5ceb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6494, "upload_time": "2019-02-23T05:53:18", "url": "https://files.pythonhosted.org/packages/35/f8/f701b6fd0c655825b0344626958065ee729614174761e988415f605f673e/CSGVulcan-0.3.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a6ce15559a38e565500925a768849141", "sha256": "755807e24d31839e1cb624d915010d2741d3daf2aff9b7c0d33b9bcea7a8036f" }, "downloads": -1, "filename": "CSGVulcan-0.3.2.tar.gz", "has_sig": false, "md5_digest": "a6ce15559a38e565500925a768849141", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6092, "upload_time": "2019-02-23T05:53:19", "url": "https://files.pythonhosted.org/packages/c8/5d/5d5ff0dcd7cb0f6bb5149792dde106ee63a62a9fe607deae8466976d3bc3/CSGVulcan-0.3.2.tar.gz" } ] }