audioarxiv 0.1.1rc56.post1__py3-none-any.whl → 0.1.2__py3-none-any.whl

audioarxiv/__init__.py

@@ -24,7 +24,7 @@ from pandas import DataFrame
 
 from . import audio, preprocess, resources
 
-__version__ = "0.1.1-rc56-post1"
+__version__ = "0.1.2"
 
 
 def get_version_information() -> str:
@@ -111,11 +111,11 @@ def env_package_list(as_dataframe: bool = False) -> list | DataFrame:
 
     Returns:
     Union[list, DataFrame]:
-    If ``as_dataframe=False`` is given, the output is a `list` of `dict`,
-    one for each package, at least with ``'name'`` and ``'version'`` keys
-    (more if `conda` is used).
-    If ``as_dataframe=True`` is given, the output is a `DataFrame`
-    created from the `list` of `dicts`.
+        If ``as_dataframe=False`` is given, the output is a `list` of `dict`,
+        one for each package, at least with ``'name'`` and ``'version'`` keys
+        (more if `conda` is used).
+        If ``as_dataframe=True`` is given, the output is a `DataFrame`
+        created from the `list` of `dicts`.
     """
     prefix = sys.prefix
     pkgs = []

audioarxiv/audio/base.py

@@ -43,6 +43,7 @@ def validate_audio_arguments(rate: float, volume: float, voice: int | str | None
             logger.error('Invalid voice ID = %s. Keeping current voice.', voice)
     elif voice is not None:
         logger.error('Unsupported datatype of voice = %s. It must be either int or str.', type(voice))
+        voice = None
     if pause_seconds < 0:
         pause_seconds = 0.1
         logger.error('pause = %s must be non-negative. Keeping the current pause.', pause_seconds)

audioarxiv/resources/paper.py

@@ -172,6 +172,9 @@ class Paper:
             list: A list of sections. Each section is a dict with the header as the key and the content as the value.
         """
         if len(self._sections) == 0:
+            if self.paper is None:
+                logger.error('Paper is None. Cannot download PDF.')
+                return self._sections
             with tempfile.NamedTemporaryFile() as tmp:
                 filename = tmp.name
                 self.download_pdf(filename=filename)

audioarxiv/tools/main.py

@@ -57,7 +57,6 @@ def initialize_configuration(args: configargparse.Namespace) -> tuple:
     os.makedirs(config_dir, exist_ok=True)
     config_file = 'config.json'
     config_path = os.path.join(config_dir, config_file)
-
     # Default settings.
     settings = {
         'audio': {
@@ -159,36 +158,35 @@ def main():
     paper = Paper(**settings['paper'])
 
     # Search the paper.
-    if args.id is not None:
-        # Print the information
-        logger.info('Configuration file: %s', config_path)
-        logger.info('Audio settings')
-        for key, value in settings['audio'].items():
-            logger.info('%s: %s', key, value)
-
-        logger.info('Paper settings')
-        for key, value in settings['paper'].items():
-            logger.info('%s: %s', key, value)
-
-        logger.info('Searching arxiv: %s...', args.id)
-        paper.search_by_arxiv_id(arxiv_id=args.id)
-        # Get the sections
-        sections = paper.sections
-        if args.output is None:
-            for section in sections:
-                audio.read_article(section['header'])
+    # Print the information
+    logger.info('Configuration file: %s', config_path)
+    logger.info('Audio settings')
+    for key, value in settings['audio'].items():
+        logger.info('%s: %s', key, value)
+
+    logger.info('Paper settings')
+    for key, value in settings['paper'].items():
+        logger.info('%s: %s', key, value)
+
+    logger.info('Searching arxiv: %s...', args.id)
+    paper.search_by_arxiv_id(arxiv_id=args.id)
+    # Get the sections
+    sections = paper.sections
+    if args.output is None:
+        for section in sections:
+            audio.read_article(section['header'])
+            time.sleep(1)
+            for content in section['content']:
+                audio.read_article(content)
                 time.sleep(1)
-                for content in section['content']:
-                    audio.read_article(content)
-                    time.sleep(1)
-        else:
-            article = []
-            for section in sections:
-                if section['header'] is not None:
-                    article.append(section['header'])
-                if section['content'] is not None:
-                    article += section['content']
-            article = " ".join(article)
-            logger.info('Saving audio...')
-            audio.save_article(filename=args.output, article=article)
-            logger.info('Audio is saved to %s.', args.output)
+    else:
+        article = []
+        for section in sections:
+            if section['header'] is not None:
+                article.append(section['header'])
+            if section['content'] is not None:
+                article += section['content']
+        article = " ".join(article)
+        logger.info('Saving audio...')
+        audio.save_article(filename=args.output, article=article)
+        logger.info('Audio is saved to %s.', args.output)

{audioarxiv-0.1.1rc56.post1.dist-info → audioarxiv-0.1.2.dist-info}/METADATA

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: audioarxiv
-Version: 0.1.1rc56.post1
+Version: 0.1.2
 Summary: Turn arXiv papers into audio. audioarxiv lets you fetch the research papers from arXiv and read them aloud.
 Author-email: "Isaac C. F. Wong" <isaac.cf.wong@gmail.com>
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.9
@@ -22,6 +22,10 @@ Requires-Dist: sympy
 Requires-Dist: nltk
 Requires-Dist: pandas
 Requires-Dist: platformdirs
+Requires-Dist: pytest ; extra == "dev"
+Requires-Dist: pre-commit ; extra == "dev"
+Requires-Dist: black ; extra == "dev"
+Requires-Dist: flake8 ; extra == "dev"
 Requires-Dist: pyspark>=3.0.0 ; extra == "spark"
 Requires-Dist: bandit[toml]==1.8.3 ; extra == "test"
 Requires-Dist: black==25.1.0 ; extra == "test"
@@ -45,6 +49,7 @@ Project-URL: Homepage, https://github.com/isaac-cf-wong/audioarxiv
 Project-URL: Release Notes, https://github.com/isaac-cf-wong/audioarxiv/releases
 Project-URL: Source, https://github.com/isaac-cf-wong/audioarxiv
 Project-URL: Tracker, https://github.com/isaac-cf-wong/audioarxiv/issues
+Provides-Extra: dev
 Provides-Extra: spark
 Provides-Extra: test
 
@@ -114,5 +119,15 @@ The settings are saved, so you only need to provide your preferred settings once
 
 ## Contributing
 
-This project welcomes contributions and suggestions. For details, visit the repository's [Contributor License Agreement (CLA)](https://cla.opensource.microsoft.com) and [Code of Conduct](https://opensource.microsoft.com/codeofconduct/) pages.
+Contributions and suggestions are welcome! Whether it's fixing bugs, improving documentation, or adding new features, your help is appreciated.
+
+Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
+
+To get started:
+
+- Fork the repository
+- Create a new branch for your changes
+- Submit a pull request
+
+If you're unsure where to begin, feel free to open an issue or ask for guidance!
 

audioarxiv-0.1.2.dist-info/RECORD

@@ -0,0 +1,15 @@
+audioarxiv/__init__.py,sha256=Mp9dcQGEY0QWnkMlD4MoPz45BLjDSOp5v96m8ZXwda0,5816
+audioarxiv/audio/__init__.py,sha256=UZx3AkhC8NZFXwQbW_sU4sQ1uGeEIRXCPDghXvZy8rY,214
+audioarxiv/audio/base.py,sha256=LLZGciBbFeaGlRqt_VF58RWOSKDZevks4U2SpWAk1To,6005
+audioarxiv/preprocess/__init__.py,sha256=NUCDDLpSwpWTBaPNdLWUVK2FhtwMPsFvXczTE21_UvU,338
+audioarxiv/preprocess/article.py,sha256=d9nV2DEH4mvKsgUpJ3WB256rt8k5O7YvNTBUp5YOUbs,394
+audioarxiv/preprocess/math_equation.py,sha256=ulkeMZFJKxU8BH1QzNyW4BZ-UjWfDDMp1C-cqoRGyls,945
+audioarxiv/resources/__init__.py,sha256=KCZm9Hq0O9oCCtfpyKVDGo_qX-PU2qS8aJe1NgvmR7Q,166
+audioarxiv/resources/paper.py,sha256=o6DD4KrcypjH810ArDzD93uBkdpKUNvnErIUJUZ3J9s,7302
+audioarxiv/tools/__init__.py,sha256=7X5vtxzvCY9URWo0p3zvM11J6whGFeDPF7XU0dt1Qcw,28
+audioarxiv/tools/main.py,sha256=n5Q22HTktaxPv1C1Z7HxkN2OJqi9F6QxSWbnzqZ448E,6735
+audioarxiv-0.1.2.dist-info/entry_points.txt,sha256=d_K6uTNuC8-f9XUQ_enFBgssiK2lVV57EHCEloriVY4,57
+audioarxiv-0.1.2.dist-info/licenses/LICENSE,sha256=EaCbwfO894O6p0QwcO_sgtKCIEWxfBS0fhybH9sURk8,1140
+audioarxiv-0.1.2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+audioarxiv-0.1.2.dist-info/METADATA,sha256=zI482AWs0OUlYlhMonZELnSxe5RNpruDyi7Jedyj9IU,5210
+audioarxiv-0.1.2.dist-info/RECORD,,

{audioarxiv-0.1.1rc56.post1.dist-info → audioarxiv-0.1.2.dist-info}/licenses/LICENSE

@@ -1,6 +1,6 @@
     MIT License
 
-    Copyright (c) Microsoft Corporation.
+    Copyright (c) 2025 Isaac C. F. Wong
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

audioarxiv-0.1.1rc56.post1.dist-info/RECORD

@@ -1,15 +0,0 @@
-audioarxiv/__init__.py,sha256=NitAtYpjQ2X_VB-5hX7qDpyw4VCLfpV1qMCPdTJpbu0,5807
-audioarxiv/audio/__init__.py,sha256=UZx3AkhC8NZFXwQbW_sU4sQ1uGeEIRXCPDghXvZy8rY,214
-audioarxiv/audio/base.py,sha256=tQOby6-12r5lInbAQChMxsQNSQT7_od4_tZ7G8hsDKE,5984
-audioarxiv/preprocess/__init__.py,sha256=NUCDDLpSwpWTBaPNdLWUVK2FhtwMPsFvXczTE21_UvU,338
-audioarxiv/preprocess/article.py,sha256=d9nV2DEH4mvKsgUpJ3WB256rt8k5O7YvNTBUp5YOUbs,394
-audioarxiv/preprocess/math_equation.py,sha256=ulkeMZFJKxU8BH1QzNyW4BZ-UjWfDDMp1C-cqoRGyls,945
-audioarxiv/resources/__init__.py,sha256=KCZm9Hq0O9oCCtfpyKVDGo_qX-PU2qS8aJe1NgvmR7Q,166
-audioarxiv/resources/paper.py,sha256=s9XT3xuzntR_0_Np29F66muou0q409jocD4sU2dtgDM,7161
-audioarxiv/tools/__init__.py,sha256=7X5vtxzvCY9URWo0p3zvM11J6whGFeDPF7XU0dt1Qcw,28
-audioarxiv/tools/main.py,sha256=sAh7izIdGmfQZiI3tBKn-zLMhQgAQvLGu4OmYnYLsAc,6884
-audioarxiv-0.1.1rc56.post1.dist-info/entry_points.txt,sha256=d_K6uTNuC8-f9XUQ_enFBgssiK2lVV57EHCEloriVY4,57
-audioarxiv-0.1.1rc56.post1.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
-audioarxiv-0.1.1rc56.post1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-audioarxiv-0.1.1rc56.post1.dist-info/METADATA,sha256=UvpJ-tny5iNHwmYtLYcYbYw78rYIVwTUZ6NN-LWpvQ0,4873
-audioarxiv-0.1.1rc56.post1.dist-info/RECORD,,