Brave Core Service API Bindings
Python API bindings for both utilizing and hosting the secure RPC mechanism.
© 2014, Alice Bevan-McGregor and contributors.
1. What are the Core Service API Bindings?
There are three primary components provided by this package:
- A method of generating keys in the correct format.
- Client API bindings.
- WebCore Controller sub-class which implements the server-side API.
2. Installation
Development takes place on GitHub in the core project. Issue tracking, documentation, and downloads are provided there.
Installing the current development version of the API Bindings requires Git, a distributed source code management system. In Debian/Ubuntu, these are found in packages `python-dev`.
Run the following to download the development version with Git, and link it into your Python runtime:
git clone https://github.com/bravecollective/api.git
(cd api; python setup.py develop)You can upgrade to the latest version at any time:
(cd api; git pull; python setup.py develop)If you would like to make changes and contribute them back to the project, fork the GitHub project, make your changes, and submit a pull request. This process is beyond the scope of this documentation; for more information, see GitHub’s documentation.
3. Key Management
TODO
4. Client Bindings
TODO
5. WebCore Secure Controller
TODO
4. License
Brave Core Service API Bindings has been released under the MIT Open Source license.
4.1. The MIT License
Copyright © 2014 Alice Bevan-McGregor and contributors.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.