diff options
Diffstat (limited to 'docs/core')
| -rwxr-xr-x | docs/core/core_api_contract | 41 | ||||
| -rw-r--r-- | docs/core/index.rst | 13 |
2 files changed, 54 insertions, 0 deletions
diff --git a/docs/core/core_api_contract b/docs/core/core_api_contract new file mode 100755 index 0000000..b70fb8f --- /dev/null +++ b/docs/core/core_api_contract @@ -0,0 +1,41 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# api_contract.py +# Copyright (C) 2016 LEAP Encryption Acess Project +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. +""" +Display a human-readable representation of the methods that compound the public +api for Bitmask Core. + +The values are meant to be type annotations. +""" + +if __name__ == "__main__": + from leap.bitmask.core.service import BitmaskBackend + from leap.bitmask.core import api + backend = BitmaskBackend() + + print '========= Bitmask Core API ==================' + print + + for key in api.registry: + human_key = key.replace('do_', '').lower() + value = api.registry[key] + + print("{}:\t\t{}".format( + human_key, + ' '.join([x for x in value]))) + print + print '=============================================' diff --git a/docs/core/index.rst b/docs/core/index.rst new file mode 100644 index 0000000..c52dcc1 --- /dev/null +++ b/docs/core/index.rst @@ -0,0 +1,13 @@ +:LastChangedDate: $LastChangedDate$ +:LastChangedRevision: $LastChangedRevision$ +:LastChangedBy: $LastChangedBy$ + +.. _bitmask_core: + +Bitmask Core +================================ +blah blah + +API documentation +-------------------------------- + |