BEP for ORM implementation of Python driver (BEP-11) #57
Conversation
ttmc
changed the title
|
It seems BEP-21 is now taken. You can probably use the name BEP-11 instead because nobody else seems to be using that number. When you make the change, please update the title of this pull request as well. |
21/README.md
Outdated
| @@ -0,0 +1,60 @@ | |||
| ``` | |||
| shortname: 21/PYTHON-ORM-DRIVER | |||
| name: Orm implementation for official bigchaindb python driver | |||
There was a problem hiding this comment.
Please write the name in title case: ORM Implementation for Official BigchainDB Python Driver
21/README.md
Outdated
|
|
||
| # Specification | ||
|
|
||
| This Orm should be implemented on top of python driver - [https://github.com/bigchaindb/bigchaindb-driver](https://github.com/bigchaindb/bigchaindb-driver). |
There was a problem hiding this comment.
Please write ORM in all caps, here and elsewhere. It's an acronym.
21/README.md
Outdated
| This Orm should be implemented on top of python driver - [https://github.com/bigchaindb/bigchaindb-driver](https://github.com/bigchaindb/bigchaindb-driver). | ||
| This implementation SHOULD include following **CRAB** operations - | ||
|
|
||
| 1. **C**reate - performs CREATE transaction with asset payload into bigchainDB. |
There was a problem hiding this comment.
Since this is a specification for a Python ORM, it should include specific names and signatures (argument lists) for the functions, classes, methods or whatever must be implemented. The names and signatures could be inspired by the ones used in the JavaScript ORM, but of course names should be "Pythonic."
https://www.python.org/dev/peps/pep-0008/#naming-conventions
|
Also, please add a line for this BEP in the root README.md file of this repository (in the table). |
innopreneur
changed the title
11/README.md
Outdated
| 1. **C**reate - performs CREATE transaction with asset payload into bigchainDB. | ||
|
|
||
| ``` | ||
| /** |
There was a problem hiding this comment.
These are C-style comments, but this is a specification for Python functions or methods, so they really should be Python-style comments, no? You can tell GitHub to format the code as Python by putting
```python
at the top of the code block. The comments could be Python docstrings, i.e. after the def line.
11/README.md
Outdated
| * creates the asset in bigchaindb | ||
| * @param {dict} inputs - dictionary containing keypairs and data for the asset | ||
| */ | ||
| def create(inputs) |
There was a problem hiding this comment.
I find it very strange that each function/method has exactly one input and it's always a dict. Why not a list of arguments and/or keyword arguments?
| @@ -0,0 +1,93 @@ | |||
| ``` | |||
| shortname: 11/PYTHON-ORM-DRIVER | |||
There was a problem hiding this comment.
If you change the shortname of this BEP to BEP-11 then we can close issue #32 because all other shortnames have been updated to the BEP-N format.
|
|
||
| # Copyright Waiver | ||
|
|
||
| _To the extent possible under law, the person who associated CC0 with this work has waived all copyright and related or neighboring rights to this work._ |
There was a problem hiding this comment.
Please replace the current copyright waiver text with the following block of HTML. (HTML is valid Markdown.)
<p xmlns:dct="http://purl.org/dc/terms/">
<a rel="license"
href="http://creativecommons.org/publicdomain/zero/1.0/">
<img src="http://i.creativecommons.org/p/zero/1.0/88x31.png" style="border-style: none;" alt="CC0" />
</a>
<br />
To the extent possible under law, all contributors to this BEP
have waived all copyright and related or neighboring rights to this BEP.
</p>
ttmc
changed the title
|
I talked to @innoprenuer about this PR today. He said that some folks on the Ocean team already wrote a BigchainDB ORM in Python, but we haven't gotten around to open sourcing it yet because other things have been higher priority. |
BEP explaining motivation and implementation of python orm driver