├── .gitignore ├── CHANGELOG.rst ├── LICENSE.txt ├── MANIFEST.in ├── README.md ├── ripozo_oasis ├── __init__.py ├── api_builder.py └── cli_commands.py └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by .ignore support plugin (hsz.mobi) 2 | ### Python template 3 | # Byte-compiled / optimized / DLL files 4 | __pycache__/ 5 | *.py[cod] 6 | *$py.class 7 | 8 | # C extensions 9 | *.so 10 | 11 | # Distribution / packaging 12 | .Python 13 | env/ 14 | build/ 15 | develop-eggs/ 16 | dist/ 17 | downloads/ 18 | eggs/ 19 | .eggs/ 20 | lib/ 21 | lib64/ 22 | parts/ 23 | sdist/ 24 | var/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .coverage 43 | .coverage.* 44 | .cache 45 | nosetests.xml 46 | coverage.xml 47 | *,cover 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | 56 | # Sphinx documentation 57 | docs/_build/ 58 | 59 | # PyBuilder 60 | target/ 61 | 62 | # PyCharm files 63 | .idea/ 64 | 65 | # Pypi 66 | setup.cfg 67 | -------------------------------------------------------------------------------- /CHANGELOG.rst: -------------------------------------------------------------------------------- 1 | CHANGELOG 2 | ````````` 3 | 4 | 1.0.2 (unreleased) 5 | ================== 6 | 7 | - Nothing changed yet. 8 | 9 | 10 | 1.0.1 (2015-12-01) 11 | ================== 12 | 13 | - Flipped order of adapters. 14 | 15 | 16 | 1.0.0 (2015-12-01) 17 | ================== 18 | 19 | - Clean up 20 | 21 | 22 | 0.1.2 (2015-12-01) 23 | ================== 24 | 25 | - Nothing changed yet. 26 | 27 | 28 | 0.1.1 (2015-12-01) 29 | ================== 30 | 31 | - Initial -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | include LICENSE.txt 3 | include CHANGELOG.rst 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # How to turn your database into a ReSTful API in under 10 lines of code 2 | 3 | A package to turn your database into a ReSTful API in just 10 lines of code. 4 | 5 | You can either install the package and simply start the API from the 6 | command line or you can follow [this tutorial](#tutorial) to build it yourself. 7 | 8 | **NOTE**: This is not intended for production. It's more of a "Look at the cool stuff I can 9 | do with some of my favorite tools" kind of package. 10 | 11 | ## Installation 12 | 13 | ```bash 14 | pip install ripozo-oasis 15 | ``` 16 | 17 | ## Running your API 18 | 19 | To turn your database into a ReSTful API simply run the following command. 20 | 21 | ```bash 22 | ripozo-oasis "mysql://localhost:3306/mydatabase" 23 | ``` 24 | 25 | You will need to pass a Database URI according to the 26 | [SQLALchemy Engine Configuration documentation](http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html). 27 | The format is `'dialect+driver://username:password@host:port/database_name'`. 28 | The driver is optional and only necessary if you do not wish to use the default. If you get import errors 29 | you will need to install a specific driver for your database. For example, with MySQL you'll need 30 | to run ``pip install mysql-python`` or for postgresql you'll need to run ``pip install psycopg2``. 31 | 32 | Now we can curl the root url to get all available endpoints 33 | 34 | ```bash 35 | curl -X OPTIONS http://localhost:5000/ 36 | ``` 37 | 38 | Assuming we had two tables, groups and users, we would see the following. 39 | 40 | ```javascript 41 | { 42 | "_embedded": {}, 43 | "_links": { 44 | "group": { 45 | "href": "/group/" 46 | }, 47 | "user": { 48 | "href": "/user/" 49 | }, 50 | "self": { 51 | "href": "http://localhost:5000/" 52 | } 53 | } 54 | } 55 | ``` 56 | 57 | We could additionally vary the Accept header to get a SIREN formatted response 58 | 59 | ```bash 60 | curl -X OPTIONS -H "Accept: application/vnd.siren+json" http://localhost:5000/ 61 | ``` 62 | 63 | ```javascript 64 | { 65 | "entities": [], 66 | "class": [""], 67 | "links": [ 68 | { 69 | "href": "http://localhost:5000/", 70 | "rel": ["self"] 71 | }, 72 | { 73 | "href": "http://localhost:5000/group/", 74 | "rel": ["group_list"] 75 | }, 76 | { 77 | "href": "http://localhost:5000/group//", 78 | "rel": ["group"] 79 | }, 80 | ... 81 | } 82 | ], 83 | "actions": [ 84 | { 85 | "fields": [], 86 | "href": "http://localhost:5000/", 87 | "title": "All Options", 88 | "method": "OPTIONS", 89 | "name": "all_options" 90 | } 91 | ], 92 | "properties": {} 93 | } 94 | ``` 95 | 96 | We have full CRUD+L (Create, Retrieve, Update, Delete and List) operations: a POST to ``/user/`` creates 97 | a new user, a GET to ``/user/`` returns a list of all users, a GET on ``/user//`` 98 | returns an individual user and so forth. 99 | 100 | ## Tutorial 101 | 102 | This tutorial uses a powerful and extensible ReST framework called 103 | [ripozo](https://github.com/vertical-knowledge/ripozo) and a couple 104 | packages in the ripozo ecosystem: [flask-ripozo](https://github.com/vertical-knowledge/flask-ripozo) 105 | and [ripozo-sqlalchemy](https://github.com/vertical-knowledge/ripozo-sqlalchemy). Ripozo 106 | is web framework independent, meaning you can use it in any desired web framework. 107 | Official integrations include [flask-ripozo](https://github.com/vertical-knowledge/flask-ripozo) 108 | and [django-ripozo](https://github.com/vertical-knowledge/django-ripozo) with more to come. 109 | In addition to building seamless ReSTful API's, ripozo can expose [Hypermedia/HATEOAS](http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven) 110 | driven API's with *no additional effort*. 111 | 112 | ### Step 1: Create the Flask App 113 | 114 | The first step is to setup our [Flask](https://github.com/mitsuhiko/flask) application. 115 | You can use [django-ripozo](https://github.com/vertical-knowledge/django-ripozo) 116 | with minimal deviations from this tutorial. 117 | Unfortunately, bootstrapping a django project requires more than 10 lines of code. 118 | 119 | First, install Flask. 120 | 121 | ```bash 122 | pip install Flask 123 | ``` 124 | 125 | Now instantiate a Flask Application. 126 | 127 | ```python 128 | from flask import Flask 129 | app = Flask(__name__) 130 | ``` 131 | 132 | ### Step 2: Setup SQLAlchemy 133 | 134 | [SQLAlchemy](http://www.sqlalchemy.org/) is another favorite tool of mine. It provides 135 | an excellent ORM and allows us to generate an ORM from an existing database 136 | with no additional work. 137 | 138 | ```bash 139 | pip install SQLAlchemy 140 | ``` 141 | 142 | Creating a sqlalchemy engine is incredibly simple. We simply 143 | pass SQLAlchemy a database URI in the expected format. See 144 | the [Engine Configuration documentation](http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html) 145 | for more details. TL;DR this is the general format: 146 | `'dialect+driver://username:password@host:port/database_name'` 147 | 148 | ```python 149 | from sqlalchemy import create_engine 150 | from sqlalchemy.ext.automap import automap_base 151 | 152 | database_uri = 'mysql://localhost:3306/mydatabase' 153 | engine = create_engine(database_uri) 154 | base = automap_base() 155 | base.prepare(engine, reflect=True) 156 | ``` 157 | 158 | This creates an ORM where we can access tables in the database 159 | as python objects. 160 | 161 | ### Step 3: Bind ripozo 162 | 163 | Now that we have our database and web application working, we need to bind 164 | [ripozo](https://github.com/vertical-knowledge/ripozo) to Flask and SQLAlchemy. 165 | 166 | ```bash 167 | pip install ripozo flask-ripozo ripozo-sqlalchemy 168 | ``` 169 | 170 | ```python 171 | from flask_ripozo import FlaskDispatcher 172 | from ripozo import adapters 173 | from ripozo_sqlalchemy import ScopedSessionHandler 174 | 175 | # Attach the previously create Flask application 176 | dispatcher = FlaskDispatcher(app) 177 | # Adapters inform ripozo how to represent the resources over HTTP (typically a 178 | # protocol for a JSON response). In this case, we've chosen the Hal and SIREN protocols. 179 | dispatcher.register_adapters(adapters.SirenAdapter, adapters.HalAdapter) 180 | # Create a session handler to cleanly handle database transactions and cleanup 181 | session_handler = ScopedSessionHandler(engine) 182 | ``` 183 | 184 | ### Step 4: Expose our database 185 | 186 | Now that we have completed all necessary setup, we can 187 | expose our database as a ReSTful API. 188 | 189 | ```python 190 | # The create_resource method is a shortcut for creating ripozo resources 191 | # containing common sets of endpoints. 192 | # We need to pass append_slash=True due to a quirk in how flask handles routing 193 | resources = [create_resource(model, session_handler, append_slash=True) for model in base.classes] 194 | # Register the resources with the adapter to expose them in the API. 195 | dispatcher.register_resources(*resources) 196 | 197 | # and now we run our Flask app 198 | app.run() 199 | ``` 200 | 201 | The ``create_resource`` method is highly customizable. Additionally, you can use a 202 | declarative, class based implementation that is incredibly flexible. In fact, 203 | the ``create_resource`` method uses the declarative implementation under the covers. 204 | 205 | ### Step 5: Putting it all together 206 | 207 | Now that we have everything we need, let's put it all together 208 | into one function. 209 | 210 | ```python 211 | from flask import Flask 212 | from flask_ripozo import FlaskDispatcher 213 | from ripozo import adapters 214 | from ripozo_sqlalchemy import ScopedSessionHandler, create_resource 215 | from sqlalchemy.ext.automap import automap_base 216 | from sqlalchemy import create_engine 217 | 218 | 219 | def create_app(database_uri): 220 | app = Flask(__name__) 221 | 222 | engine = create_engine(database_uri) 223 | base = automap_base() 224 | base.prepare(engine, reflect=True) 225 | 226 | dispatcher = FlaskDispatcher(app) 227 | dispatcher.register_adapters(adapters.HalAdapter, adapters.SirenAdapter) 228 | session_handler = ScopedSessionHandler(engine) 229 | 230 | resources = [create_resource(model, session_handler, append_slash=True) for model in base.classes] 231 | dispatcher.register_resources(*resources) 232 | 233 | app.run() 234 | ``` 235 | 236 | And just like that we have exposed our database as a ReSTful API. Additionally, 237 | because this is [ripozo](https://github.com/vertical-knowledge/ripozo), if a table 238 | has a relationship to another table, a link to the corresponding row/resource is 239 | automatically generated. For example, consider a user table has a Many-to-One relationship with a group table. 240 | When we go to a user's endpoint, we'll get a fully qualified URL linking to the associated group's endpoint. 241 | 242 | 243 | ## Conclusion 244 | 245 | We can see how easy [ripozo](https://github.com/vertical-knowledge/ripozo) makes 246 | creating ReSTful API's. With [ripozo](https://github.com/vertical-knowledge/ripozo), 247 | you can include authentication and authorization, additional endpoints and much more. 248 | [Ripozo](https://github.com/vertical-knowledge/ripozo) is designed to be flexible and 249 | efficient at the same time. It provides shortcuts 250 | while priotizing extensibility. It unleashes more flexibility and power than 251 | any other Hypermedia/HATEOAS ReSTful framework. Ripozo: less effort, better APIs. 252 | 253 | -------------------------------------------------------------------------------- /ripozo_oasis/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | from __future__ import division 3 | from __future__ import print_function 4 | from __future__ import unicode_literals 5 | 6 | from ripozo_oasis.api_builder import create_app 7 | -------------------------------------------------------------------------------- /ripozo_oasis/api_builder.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | from __future__ import division 3 | from __future__ import print_function 4 | from __future__ import unicode_literals 5 | 6 | from flask import Flask 7 | from flask_ripozo import FlaskDispatcher 8 | from ripozo import adapters 9 | from ripozo_sqlalchemy import ScopedSessionHandler, create_resource 10 | from sqlalchemy.ext.automap import automap_base 11 | from sqlalchemy import create_engine 12 | 13 | 14 | def create_app(database_uri): 15 | """ 16 | Creates a new flask app that exposes the database 17 | provided as a ReSTful Application 18 | 19 | :param str|unicode|sqlalchemy.engine.url.URL database_uri: The database 20 | URI in a manner that SQLAlchemy can understand 21 | :return: A flask app that exposes a database as 22 | a ReSTful API that can be accessed using either 23 | the Hal or SIREN protocol 24 | :rtype: Flask 25 | """ 26 | # Create the flask application 27 | app = Flask(__name__) 28 | 29 | # Setup SQLAlchemy to reflect the database 30 | engine = create_engine(database_uri) 31 | base = automap_base() 32 | base.prepare(engine, reflect=True) 33 | 34 | # Create the ripozo dispatcher and register the response formats 35 | dispatcher = FlaskDispatcher(app) 36 | dispatcher.register_adapters(adapters.HalAdapter, adapters.SirenAdapter) 37 | session_handler = ScopedSessionHandler(engine) 38 | 39 | # Create and register resources from the sqlalchemy models 40 | # We need to pass ``append_slash=True`` due to a quirk in how flask handles routing 41 | resources = [create_resource(model, session_handler, append_slash=True) for model in base.classes] 42 | dispatcher.register_resources(*resources) 43 | return app 44 | -------------------------------------------------------------------------------- /ripozo_oasis/cli_commands.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | from __future__ import division 3 | from __future__ import print_function 4 | from __future__ import unicode_literals 5 | 6 | import traceback 7 | 8 | import click 9 | from sqlalchemy.engine.url import URL 10 | 11 | from ripozo_oasis.api_builder import create_app 12 | 13 | 14 | @click.command() 15 | @click.argument('database_uri', required=False) 16 | @click.option('-p', '--port', type=int, help='The port of the database that you wish to expose') 17 | @click.option('-h', '--host', type=str, help='The data base host e.g. "localhost"') 18 | @click.option('-d', '--dialect', type=str, help='The database dialect e.g. "mysql" or "postgres"') 19 | @click.option('--driver', type=str, help='The database driver to use e.g. "psycopg2" or "pg8000"') 20 | @click.option('-n', '--name', type=str, help='The database name') 21 | @click.option('-u', '--user', type=str, help='The database user') 22 | @click.option('-p', '--password', type=str, help='The database user\'s password if necessary') 23 | @click.option('--debug', is_flag=True, help='A flag to run the application in debug mode') 24 | @click.option('--app-port', type=int, help='The port to run the application on') 25 | def auto_ripozo_db(app_port, debug, password, user, name, driver, dialect, host, port, database_uri): 26 | """ 27 | Creates and starts a ReSTful API from a database. Full CRUD+L (Create, 28 | Retrieve, Update, Delete, and List) is available for every model in the 29 | database. Additionally, the application is completely HATEOAS with 30 | full urls pointing to related objects. 31 | 32 | See the SQLAlchemy documentation on 33 | `Engine Configuration `_ 34 | for more details on constructing a datbase uri. 35 | 36 | Either the database_uri argument is required or host, port, name and dialect are 37 | required at a minimum. 38 | """ 39 | if not database_uri: 40 | dialect = '{0}+{1}'.format(dialect, driver) if driver else dialect 41 | database_uri = URL(dialect, username=user, password=password, host=host, 42 | port=port, database=name) 43 | 44 | try: 45 | app = create_app(database_uri) 46 | except ImportError: 47 | traceback.print_exc() 48 | print() 49 | print("It appears there was an import error. Typically," 50 | " this is because you are missing the driver. Simply " 51 | "pip install the driver you prefer for your database and " 52 | "try again.") 53 | print("For example, for MySQL `pip install MySQL-python` or " 54 | "for PostGreSQL: `pip install psycopg2`. ") 55 | print("Check out this link for more details: " 56 | "http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html") 57 | print() 58 | else: 59 | app.run(debug=debug, port=app_port) 60 | 61 | 62 | def run_commands(): 63 | auto_ripozo_db() 64 | 65 | if __name__ == '__main__': 66 | auto_ripozo_db() 67 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | from __future__ import division 3 | from __future__ import print_function 4 | from __future__ import unicode_literals 5 | 6 | from setuptools import setup, find_packages 7 | 8 | version = '1.0.2.dev0' 9 | 10 | setup( 11 | author='Tim Martin', 12 | author_email='tim.martin@vertical-knowledge.com', 13 | entry_points={ 14 | 'console_scripts': [ 15 | 'ripozo-oasis = ripozo_oasis.cli_commands:run_commands' 16 | ] 17 | }, 18 | extras_require={ 19 | 'dev': [ 20 | 'zest.releaser' 21 | ] 22 | }, 23 | install_requires=[ 24 | 'click==5.1', 25 | 'Flask==0.10.1', 26 | 'ripozo==1.2.3', 27 | 'flask-ripozo==1.0.1', 28 | 'ripozo-sqlalchemy==1.0.1', 29 | 'SQLAlchemy==1.0.9' 30 | ], 31 | name='ripozo-oasis', 32 | packages=find_packages(include=['ripozo_oasis', 'ripozo_oasis.*']), 33 | version=version 34 | ) 35 | --------------------------------------------------------------------------------