Minor improvements, Readme updates

Author: Mijago

README.md

@@ -9,22 +9,24 @@ My Twitter: https://twitter.com/MijagoCoding/
 
 # How to Use?
 3) Install all required packages
-   1) `python -m pip install pandas plotly pathos requests pretty_html_table bar-chart-race`
-   2) If you want to use mp4 instead of gif, also install `python -m pip install python-ffmpeg` and put a [ffmpeg](https://www.ffmpeg.org/download.html) in your PATH variable. Then set the `VIDEO_TYPE` in `main.py` to `mp4`. 
+   1) `python3 -m pip install pandas plotly pathos requests pretty_html_table bar-chart-race tqdm`
+   2) If you want to use mp4 instead of gif, also install `python3 -m pip install python-ffmpeg` and put a [ffmpeg](https://www.ffmpeg.org/download.html) in your PATH variable. Then set the `VIDEO_TYPE` in `main.py` to `mp4`. 
 
       **I highly encourage you to do this, as the gifs tend to be 40mb in size, whereas the mp4 is only around 1.5mb~2mb**.
 
       Download it here: [ffmpeg](https://github.com/BtbN/FFmpeg-Builds/releases) (for Windows, `ffmpeg-n5.0-latest-win64-gpl-5.0.zip`).
-4) Add your api key to `main.py`. For this, edit `api = BungieApi("API-KEY")`. Get it [here](https://www.bungie.net/en/Application).
-5) Edit your user info in `main.py`.
+4) Set your API key as an environemnt variable `BUNGIE_API_KEY`.  Get the key [here](https://www.bungie.net/en/Application).
+   1) Alternatively: Add your api key to `main.py`. For this, edit `# API_KEY = "123456789"`.
+5) Edit your user info in `main.py`. Alternatively, you can also use command line parameters to set this later.
    ```py
    MEMBERSHIP_MIJAGO = (3, 4611686018482684809)
    MEMBERSHIP_MYCOOLID = (1, 1231231231231233353) # for example, add this
    USED_MEMBERSHIP = MEMBERSHIP_MYCOOLID
-   api = BungieApi("API-KEY")
    ```
-6) Run! `python3 main.py`
-   1) May take a while. I need 35~45 seconds for 1000 PGCRs with a download speed of 4.5mb/s.
+6) Run the script `python3 main.py`.
+   1) Complete Example: `BUNGIE_API_KEY=123456789012345   python3 main.py -p 3 -id 4611686018482684809`
+   2) Alternatively you can also specify the platform and user: `python3 main.py -p 3 -id 4611686018482684809`
+   3) This may take a while. I need 35~45 seconds for 1000 PGCRs with a download speed of 4.5mb/s.
 
 # Where do I get my user ID?
 1) Go to https://www.d2checklist.com (or any other similar page)

app/DiscordSender.py

@@ -66,7 +66,7 @@ def downloadActivityPage(page):
 
         return self
 
-    def getPGCRs(self, pagesize=1000):
+    def getPGCRs(self):
         bungo = self.api
 
         def downloadPGCR(activity):
@@ -81,20 +81,12 @@ def downloadPGCR(activity):
             with open("%s/pgcr_%s.json" % (Director.GetPGCRDirectory(self.membershipType, self.membershipId), pgcr["activityDetails"]["instanceId"]), "w", encoding='utf-8') as f:
                 f.write(json.dumps(pgcr))
 
-        stepsize = pagesize
-        START_PAGE = 0
-
         if len(self.activities) == 0:
             print("No activities to grab")
             return self
 
-        for steps in range(START_PAGE, (len(self.activities) + stepsize - 1) // stepsize):
-            try:
-                with Timer("Get PGCRs %d through %d" % (steps * stepsize + 1, min(len(self.activities), (steps + 1) * stepsize))):
-                    # self.processPool.restart(True)
-                     self.processPool.amap(downloadPGCR, self.activities[steps * stepsize:(steps + 1) * stepsize]).get()
-            except Exception as e:
-                print(e)
+        from tqdm.auto import tqdm   
+        list(tqdm(self.processPool.imap(downloadPGCR, self.activities), total=len(self.activities), desc="Downloading PGCRs"))
         return self
 
     def combineAllPgcrs(self):

app/PgcrCollector.py

@@ -19,7 +19,6 @@
 from app.reports.WeaponRaceReport import WeaponRaceReport
 from app.reports.WeaponReport import WeaponReport
 from app.reports.WeekdayReport import WeekdayReport
-# from app.DiscordSender import DiscordSender
 
 ###############################################################################
 #
@@ -31,49 +30,50 @@
 
     # build argument parsing
     descriptionString = """Get and compile stats for a Destiny 2 user.
-    example: main.py 3 4611686018482684809"""
+    example: main.py -p 3 -id 4611686018482684809"""
     platformString = """    Xbox     1
     Psn      2
     Steam    3
     Blizzard 4
     Stadia   5
     Egs      6"""
     parser = argparse.ArgumentParser(prog='main.py', description=f'{descriptionString}', formatter_class=argparse.RawTextHelpFormatter)
-    parser.add_argument('-p', type=int, required=False, dest='platform', help=f'{platformString}')
-    parser.add_argument('-id', type=int, required=False, help='bungie ID')
+    parser.add_argument('--platform', '-p', type=int, required=False, help=f'{platformString}')
+    parser.add_argument('--membership_id', '-id', type=int, required=False, help='Bungie ID')
     args = vars(parser.parse_args())
     platform = args['platform']
-    id = args['id']
+    id = args['membership_id']
 
     if platform != None and id != None:
         USED_MEMBERSHIP = (platform, id)
     else:
         MIJAGO = (3, 4611686018482684809)
-        SUPERQ = (3, 4611686018472661350)
-        SHTGUNWEDDING = (2, 4611686018428655241)
-        EURO = (3, 4611686018471254627)
-        DREDGENQ = (3, 4611686018534347056)
-        SPRQMAN = (2, 4611686018436271063)
-        USED_MEMBERSHIP = DREDGENQ
+        # You can easily set your own ID here:
+        MYCOOLID = (3, 1234567890123456789)
+        USED_MEMBERSHIP = MIJAGO
 
-    from pathos.multiprocessing import ProcessPool
+    from pathos.multiprocessing import ProcessPool, ThreadPool, ThreadingPool
     pathos.helpers.freeze_support()  # required for windows
     pool = ProcessPool()
-    # You could also specify the amount of threads. Not that this DRASTICALLY speeds up the process but takes serious computation power.
-    # pool = ProcessPool(60)
+    # You could also specify the amount of threads. Note that this DRASTICALLY speeds up the process but takes serious computation power.
+    # pool = ProcessPool(40)
 
     # check manifest
     manifest = DestinyManifest().update()
 
-    api = BungieApi(os.getenv('BUNGIE_API_KEY'))
+    # You can also set an api key manually, if you do not want to use environment variables.
+    API_KEY = os.getenv('BUNGIE_API_KEY')
+    # API_KEY = "123456789"
+    
+    api = BungieApi(API_KEY)
     # "gif by default, "mp4" if you installed ffmpeg which you should; see README.d
     VIDEO_TYPE = "mp4"
 
     Director.CreateDirectoriesForUser(*USED_MEMBERSHIP)
     Director.ClearResultDirectory(*USED_MEMBERSHIP)
     Director.CreateDirectoriesForUser(*USED_MEMBERSHIP)
     pc = PGCRCollector(*USED_MEMBERSHIP, api, pool)
-    pc.getCharacters().getActivities(limit=None).getPGCRs(pagesize=1000)  # .combineAllPgcrs()
+    pc.getCharacters().getActivities(limit=None).getPGCRs()  # .combineAllPgcrs()
     data = pc.getAllPgcrs()
 
     pool.close()
@@ -101,6 +101,3 @@
 
     Zipper.zip_directory(Director.GetResultDirectory(*USED_MEMBERSHIP), Director.GetZipPath(*USED_MEMBERSHIP))
     print("Generated ZIP:", Director.GetZipPath(*USED_MEMBERSHIP))
-
-    # DiscordSender.send(Director.GetZipPath(*USED_MEMBERSHIP), *USED_MEMBERSHIP)
-    # print("Sent ZIP:", Director.GetZipPath(*USED_MEMBERSHIP))