@@ -97,7 +97,7 @@ def put(self, url, data):
9797
9898class WikiBot (BaseBot ):
9999 """
100- Get functions for all camptocamp.org wiki
100+ Get functions for all camptocamp.org wiki
101101 """
102102
103103 @property
@@ -414,22 +414,22 @@ def get_participants(self, url):
414414class CampBot (object ):
415415 """
416416 CampBot() object is the main class. You must instanciate only one instance of it.
417- It contains two property :
417+ It contains two property :
418418
419419 * ``wiki`` for interacting with camptocamp.org wiki
420420 * ``forum`` for interacting with camptocamp.org forum
421421 """
422422
423423 def __init__ (self , min_delay = None , proxies = None , use_demo = False ):
424424 """
425- :param min_delay: in seconds, minimum delay between each request
426- :param proxies: key-url dictionary
427- :param use_demo: Boolean, True if you want to use C2C demo API
428-
429- :Example:
430-
431- >>> bot = CampBot(min_delay=10, proxies={"https": "https://login:password@proxy.com"})
432-
425+ :param min_delay: in seconds, minimum delay between each request
426+ :param proxies: key-url dictionary
427+ :param use_demo: Boolean, True if you want to use C2C demo API
428+
429+ :Example:
430+
431+ >>> bot = CampBot(min_delay=10, proxies={"https": "https://login:password@proxy.com"})
432+
433433 """
434434
435435 domain = "camptocamp" if not use_demo else "demov6.camptocamp"
@@ -459,12 +459,12 @@ def __init__(self, min_delay=None, proxies=None, use_demo=False):
459459
460460 def login (self , login , password ):
461461 """
462- Login to camptocamp.org, mandatory for write actions.
463- It also sign-in to forum.
462+ Login to camptocamp.org, mandatory for write actions.
463+ It also sign-in to forum.
464+
465+ :param login: bot login used to sign-in (not the numerical ID)
466+ :param password: bot password
464467
465- :param login: bot login used to sign-in (not the numerical ID)
466- :param password: bot password
467-
468468 """
469469
470470 logging .info (f"Logging to wiki with account { login } ..." )
@@ -527,12 +527,12 @@ def clean(
527527 self , url_or_filename , lang , ask_before_saving , thread_url , clean_bbcode = False
528528 ):
529529 """
530- Clean a set of document.
530+ Clean a set of document.
531531
532- :param url_or_filename: Camptocamp.org URL, or filename
533- :param lang: lang identifier
534- :param ask_before_saving: Boolean
535- :param clean_bbcode: Boolean
532+ :param url_or_filename: Camptocamp.org URL, or filename
533+ :param lang: lang identifier
534+ :param ask_before_saving: Boolean
535+ :param clean_bbcode: Boolean
536536
537537 """
538538
@@ -545,10 +545,10 @@ def clean(
545545
546546 def report (self , url_or_filename , lang ):
547547 """
548- Make quality report on a set of document.
548+ Make quality report on a set of document.
549549
550- :param url_or_filename: Camptocamp.org URL, or filename
551- :param langs: comma-separated list of lang identifiers
550+ :param url_or_filename: Camptocamp.org URL, or filename
551+ :param langs: comma-separated list of lang identifiers
552552 """
553553
554554 documents = [d for d in self .get_documents (url_or_filename )]
@@ -627,7 +627,12 @@ def _process_documents(
627627
628628 for processor in processors :
629629 if processor .ready_for_production :
630- if processor (document , [lang ,]):
630+ if processor (
631+ document ,
632+ [
633+ lang ,
634+ ],
635+ ):
631636 messages .append (processor .comment )
632637 must_save = True
633638
@@ -655,10 +660,10 @@ def _process_documents(
655660
656661 def export (self , url , filename = None ):
657662 """
658- Export all document given by a camptocamp.org url
663+ Export all document given by a camptocamp.org url
659664
660- :param url: Camptocamp.org URL
661- :param filename: Output file name. Defaut : <document_type>.csv
665+ :param url: Camptocamp.org URL
666+ :param filename: Output file name. Defaut : <document_type>.csv
662667
663668 """
664669
@@ -702,11 +707,11 @@ def export(self, url, filename=None):
702707
703708 def export_contributions (self , starts = None , ends = None , filename = None ):
704709 """
705- Export all document given by a camptocamp.org url
710+ Export all document given by a camptocamp.org url
706711
707- :param starts: Start date, default is now minus 24 hours
708- :param ends: default is now
709- :param filename: Output file name. Defaut : contributions.csv
712+ :param starts: Start date, default is now minus 24 hours
713+ :param ends: default is now
714+ :param filename: Output file name. Defaut : contributions.csv
710715
711716 """
712717
0 commit comments