Better doc + credits

This commit is contained in:
Lucas Verney 2016-09-30 11:37:29 -04:00
parent 4820290aae
commit 2ea9877be5
6 changed files with 34 additions and 2 deletions

1
.gitignore vendored
View File

@ -1,3 +1,4 @@
*.pyc *.pyc
*.swp
konnectors.json* konnectors.json*
out.json out.json

View File

@ -47,10 +47,19 @@ Each module map has a `cookies` entry containing the cookies used to fetch the
data, so that any program running afterwards can download documents. data, so that any program running afterwards can download documents.
The other entries in these maps depend on the module capabilities as defined The other entries in these maps depend on the module capabilities as defined
by Weboob. by Weboob. Detailed informations about these other entires can be found in the
`doc/capabilities` folder.
## License ## License
The content of this repository is licensed under an MIT license, unless The content of this repository is licensed under an MIT license, unless
explicitly mentionned otherwise. explicitly mentionned otherwise.
## Credits
* [Cozy](http://cozy.io/) and the cozy guys on #cozycloud @ freenode
* [Weboob](http://weboob.org/) and the weboob guys on #weboob @ freenode
* [Kresus](https://github.com/bnjbvr/kresus/) for giving the original idea and
base code.

View File

@ -23,6 +23,8 @@ def to_cozy(document):
subscriptions = None subscriptions = None
# Fetch and clean the list of bills # Fetch and clean the list of bills
# Bills are formatted final documents emitted by the third party (typically
# monthly bills for a phone service provider)
try: try:
assert subscriptions assert subscriptions
bills = { bills = {
@ -37,7 +39,8 @@ def to_cozy(document):
# Fetch and clean the list of details of the subscription (detailed # Fetch and clean the list of details of the subscription (detailed
# consumption) # consumption)
# TODO: What is this? # Details are aggregated billing counts (typically aggregated counts by
# communication type for a phone service provider)
try: try:
assert subscriptions assert subscriptions
detailed_bills = { detailed_bills = {
@ -51,6 +54,8 @@ def to_cozy(document):
detailed_bills = None detailed_bills = None
# Fetch and clean the list of history bills # Fetch and clean the list of history bills
# History bills are detailed bills for any event that resulted in a bill
# (typically any communication for a phone service provider)
try: try:
assert subscriptions assert subscriptions
history_bills = { history_bills = {

View File

@ -2,6 +2,9 @@
""" """
Wrapper script around Weboob to be able to use it in combination with Cozy + Wrapper script around Weboob to be able to use it in combination with Cozy +
Konnectors easily. Konnectors easily.
Part of this code comes from [Kresus](https://github.com/bnjbvr/kresus/)
written by bnjbvr and released under MIT.
""" """
from __future__ import print_function from __future__ import print_function

View File

@ -0,0 +1,11 @@
CapDocument
===========
This capability is used for modules that have billing support.
| Key | Value |
|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| subscriptions | List of subscriptions (contracts) |
| bills | Map of bills for each subscription. Bills are final document produced by the third party. |
| history_bills | Map of history bills for each subscription. History bills are detailed counts for any event resulting in a transaction (typically any communication for a phone service provider) |
| detailed_bills | Map of detailed bills for each subscription. Detailed bills are aggregated counts by facturation type (typically voice and texts for a phone service provider) |

View File

@ -1,6 +1,9 @@
""" """
This module implements a custom JSON writer to be able to serialize data This module implements a custom JSON writer to be able to serialize data
returned by Weboob and pretty print the output JSON. returned by Weboob and pretty print the output JSON.
Based upon
http://stackoverflow.com/questions/11875770/how-to-overcome-datetime-datetime-not-json-serializable-in-python.
""" """
import json import json