{
"info": {
"author": "Nap Joseph Calub",
"author_email": "njncalub+apistar_mongoengine@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 1 - Planning",
"Environment :: Web Environment",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3 :: Only",
"Topic :: Internet :: WWW/HTTP :: Dynamic Content",
"Topic :: Software Development :: Libraries :: Python Modules"
],
"description": "apistar-mongoengine\n===================\n\n|development status| |pypi version| |build status| |coverage|\n\n.. |development status| image:: https://img.shields.io/badge/development%20status-planning-lightgrey.svg\n :target: https://github.com/njncalub/apistar-mongoengine/issues\n\n.. |pypi version| image:: https://img.shields.io/badge/version-0.0.6-blue.svg\n :target: https://pypi.org/project/apistar-mongoengine\n\n.. |build status| image:: https://travis-ci.org/njncalub/apistar-mongoengine.svg?branch=master\n :target: https://travis-ci.org/njncalub/apistar-mongoengine\n\n.. |coverage| image:: https://coveralls.io/repos/github/njncalub/apistar-mongoengine/badge.svg?branch=master\n :target: https://coveralls.io/github/njncalub/apistar-mongoengine?branch=master\n\n\nShameless bootleg copy of `flask-mongoengine `_ for `API Star `_, modified for personal taste. Contributions are most welcome!\n\nInstallation\n------------\n\n.. code:: bash\n\n $ pip install apistar-mongoengine\n\nGetting Started\n---------------\n\nFor your classes, use ``Document`` from ``apistar_mongoengine.models``.\n\n.. code:: python\n\n from apistar_mongoengine.models import Document\n from mongoengine import StringField\n\n class TodoItem(Document):\n title = StringField(required=True)\n\nAdd ``MongoClientComponent`` to your app's components to initialize the mongodb connection.\n\n.. code:: python\n\n from apistar import App, Route\n from apistar_mongoengine.components import MongoClientComponent\n from yourapp.models import TodoItem\n\n def list_items():\n return [\n item.title\n for item in TodoItem.objects.all()\n ]\n\n routes = [\n Route(url='/items/', method='GET', handler=list_items),\n ]\n components = [\n MongoClientComponent(host='mongodb://localhost:27017/todoapp'),\n ]\n\n app = App(routes=routes, components=components)\n\n if __name__ == '__main__':\n app.serve(host='127.0.0.1', port=5000, debug=True)\n\nCheck the `example `_ for more details.\n\nRunning tests and getting the overall coverage\n----------------------------------------------\n\n1. Install the required dependencies:\n\n.. code:: bash\n\n $ cd \n $ pipenv install\n\n2. Run ``flake8``:\n\n.. code:: bash\n\n $ pipenv run flake8\n\n3. Run ``pytest`` with ``coverage`` flags:\n\n.. code:: bash\n\n $ pipenv run pytest --cov-report html --cov apistar_mongoengine/ --verbose\n\n4. Open ``./htmlcov/index.html`` in your browser.\n\nContributing\n------------\n\n**Imposter syndrome disclaimer**: We want your help. No, really.\n\nThere may be a little voice inside your head that is telling you that you're not ready to be an open source contributor; that your skills aren't nearly good enough to contribute. What could you possibly offer a project like this one?\n\nWe assure you - the little voice in your head is wrong. If you can write code at all, you can contribute code to open source. Contributing to open source projects is a fantastic way to advance one's coding skills. Writing perfect code isn't the measure of a good developer (that would disqualify all of us!); it's trying to create something, making mistakes, and learning from those mistakes. That's how we all improve, and we are happy to help others learn.\n\nBeing an open source contributor doesn't just mean writing code, either. You can help out by writing documentation, tests, or even giving feedback about the project (and yes - that includes giving feedback about the contribution process). Some of these contributions may be the most valuable to the project as a whole, because you're coming to the project with fresh eyes, so you can see the errors and assumptions that seasoned contributors have glossed over.\n\nLicense\n-------\n\nMIT licensed. Please see the bundled `LICENSE file `_ for more details.",
"description_content_type": "",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "http://github.com/njncalub/apistar-mongoengine",
"keywords": "",
"license": "MIT",
"maintainer": "",
"maintainer_email": "",
"name": "apistar-mongoengine",
"package_url": "https://pypi.org/project/apistar-mongoengine/",
"platform": "any",
"project_url": "https://pypi.org/project/apistar-mongoengine/",
"project_urls": {
"Homepage": "http://github.com/njncalub/apistar-mongoengine"
},
"release_url": "https://pypi.org/project/apistar-mongoengine/0.0.6/",
"requires_dist": null,
"requires_python": "",
"summary": "Shameless bootleg copy of flask-mongoengine for API Star.",
"version": "0.0.6"
},
"last_serial": 3872734,
"releases": {
"0.0.2": [
{
"comment_text": "",
"digests": {
"md5": "3314b1098eee48a5ea627254462d0fe2",
"sha256": "67a433ac1de93442df6bded9f891a7109d44097410bc79eabc7fda669020602c"
},
"downloads": -1,
"filename": "apistar-mongoengine-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "3314b1098eee48a5ea627254462d0fe2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1728,
"upload_time": "2018-05-09T12:40:44",
"url": "https://files.pythonhosted.org/packages/d7/87/e34be525335afe583e6cbe1df5d1a766d4aaab79c4210bd5a3aeeb583132/apistar-mongoengine-0.0.2.tar.gz"
}
],
"0.0.3": [
{
"comment_text": "",
"digests": {
"md5": "d5ca76676a518860d8b85c31ed10a48d",
"sha256": "7165234ab209b1b23671e9b821e171dc2e5a97261b92c8a78ac143b4208680d4"
},
"downloads": -1,
"filename": "apistar-mongoengine-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "d5ca76676a518860d8b85c31ed10a48d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4664,
"upload_time": "2018-05-09T13:00:18",
"url": "https://files.pythonhosted.org/packages/bf/68/80e09510132d5c59c6d65296054417e181fded24fd4e474723cdf580b9bf/apistar-mongoengine-0.0.3.tar.gz"
}
],
"0.0.4": [
{
"comment_text": "",
"digests": {
"md5": "a09ed0a31f5c780e88e5480156c798a1",
"sha256": "b7c2ecdd21c84d1e0c016141723878f588d9b0461f786e150b407cfa9cd63bf6"
},
"downloads": -1,
"filename": "apistar-mongoengine-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "a09ed0a31f5c780e88e5480156c798a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4781,
"upload_time": "2018-05-10T01:25:57",
"url": "https://files.pythonhosted.org/packages/10/20/b504fc8e39e05756e3c257f71d8754c3ef2372ef31a1201d0dc6aef7761b/apistar-mongoengine-0.0.4.tar.gz"
}
],
"0.0.5": [
{
"comment_text": "",
"digests": {
"md5": "d3711be1f0dfb7b7573bb7d9074c9b35",
"sha256": "de0c26aeabc446bc98242353f498d3d34f8de4d1a5ff930427e09d0bb11a4ad7"
},
"downloads": -1,
"filename": "apistar-mongoengine-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "d3711be1f0dfb7b7573bb7d9074c9b35",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5805,
"upload_time": "2018-05-10T13:24:41",
"url": "https://files.pythonhosted.org/packages/6a/4d/d49e4bb8f3bcbec134f5f889cbea401b6f402c03cf253d77291e3e1bd444/apistar-mongoengine-0.0.5.tar.gz"
}
],
"0.0.6": [
{
"comment_text": "",
"digests": {
"md5": "6087a1015328b97035f7c38c0cb88855",
"sha256": "8f17253ffc5fcb639d6cc18091fe415d0cbfc82dfdc8e8257a01fe7a9f0be387"
},
"downloads": -1,
"filename": "apistar-mongoengine-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "6087a1015328b97035f7c38c0cb88855",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6130,
"upload_time": "2018-05-17T15:18:48",
"url": "https://files.pythonhosted.org/packages/91/ca/72e9645ad15101a19a5d6509ba25b5fbe237d11904e4ea970b927f0d79ec/apistar-mongoengine-0.0.6.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "6087a1015328b97035f7c38c0cb88855",
"sha256": "8f17253ffc5fcb639d6cc18091fe415d0cbfc82dfdc8e8257a01fe7a9f0be387"
},
"downloads": -1,
"filename": "apistar-mongoengine-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "6087a1015328b97035f7c38c0cb88855",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6130,
"upload_time": "2018-05-17T15:18:48",
"url": "https://files.pythonhosted.org/packages/91/ca/72e9645ad15101a19a5d6509ba25b5fbe237d11904e4ea970b927f0d79ec/apistar-mongoengine-0.0.6.tar.gz"
}
]
}