audioarxiv 0.1.1rc56.post1__tar.gz → 0.1.2__tar.gz

{audioarxiv-0.1.1rc56.post1 → audioarxiv-0.1.2}/.github/workflows/CI.yml

@@ -36,7 +36,7 @@ jobs:
 
       - name: Run tests with coverage
         run: |
-          pytest --cov=audioarxiv --cov-report=xml
+          pytest --cov=audioarxiv --cov-report=xml -m ""
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5

audioarxiv-0.1.2/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

audioarxiv-0.1.2/CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing to audioarxiv
+
+🎉 Thank you for your interest in contributing to `audioarxiv`! 🎧📚
+Your ideas, fixes, and improvements are welcome and appreciated.
+
+Whether you’re fixing a typo, reporting a bug, suggesting a feature, or submitting a pull request—this guide will help you get started.
+
+## 📌 How to Contribute
+
+1. Open an Issue
+
+- Have a question, bug report, or feature suggestion? [Open an issue](https://github.com/isaac-cf-wong/audioarxiv/issues/new/choose) and describe your idea clearly.
+- Check for existing issues before opening a new one.
+
+2. Fork and Clone the Repository
+
+```shell
+git clone git@github.com:<your-username>/audioarxiv.git
+cd audioarxiv
+```
+
+3. Set Up Your Environment
+
+We recommend using a virtual environment:
+
+```shell
+python -m venv venv
+source venv/bin/activate  # on Windows: venv\Scripts\activate
+pip install -e ".[dev]"
+```
+
+4. Set Up Pre-commit Hooks
+
+We use pre-commit to ensure code quality and consistency. After installing dependencies, run:
+
+```shell
+pre-commit install
+```
+
+This ensures checks like code formatting, linting, and basic hygiene run automatically when you commit.
+
+5. Create a New Branch
+
+Give it a meaningful name like fix-typo-in-docs or feature-add-summary-option.
+
+6. Make Changes
+
+- Write clear, concise, and well-documented code.
+- Follow [PEP 8](https://pep8.org/) style conventions.
+- Add or update unit tests when applicable.
+
+7. Run Tests
+
+Ensure that all tests pass before opening a pull request:
+
+```shell
+pytest
+```
+
+8. Open a Pull Request
+
+Clearly describe the motivation and scope of your change. Link it to the relevant issue if applicable.
+The pull request titles should match the [Conventional Commits spec](https://www.conventionalcommits.org/).
+
+## 💡 Tips
+
+- Be kind and constructive in your communication.
+- Keep PRs focused and atomic—smaller changes are easier to review.
+- Document new features and update existing docs if needed.
+- Tag your PR with relevant labels if you can.
+
+## 📜 Licensing
+
+By contributing, you agree that your contributions will be licensed under the project’s MIT License.
+
+---
+
+Thanks again for being part of the audioarxiv community!
+
+---

{audioarxiv-0.1.1rc56.post1 → audioarxiv-0.1.2}/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 → audioarxiv-0.1.2}/PKG-INFO

@@ -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.1rc56.post1 → audioarxiv-0.1.2}/README.md

@@ -64,4 +64,14 @@ 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/SECURITY.md

@@ -0,0 +1,36 @@
+# Security Policy
+
+We will support the latest stable release of `audioarxiv`. Please make sure you are using the most recent version before reporting a security issue.
+
+| Version | Supported |
+| ------- | --------- |
+| 0.1.x   | ✅        |
+| < 0.1   | ❌        |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in `audioarxiv`, we encourage you to report it responsibly.
+
+**Please do not open a public issue.** Instead, contact us directly via email:
+
+📧 [isaac.cf.wong@gmail.com](mailto:isaac.cf.wong@gmail.com)
+
+Include as much information as possible to help us understand and reproduce the issue quickly and accurately:
+
+- Description of the vulnerability
+- Steps to reproduce
+- Affected versions
+- Your operating system and Python version
+
+We aim to respond to all security-related emails within **3–5 business days**.
+
+## Responsible Disclosure Process
+
+1. Submit the vulnerability report via email (see above).
+2. We will acknowledge receipt and begin investigation.
+3. We will work on a fix and prepare a patch release.
+4. Once the issue is resolved, we will publish an advisory and credit you (if desired).
+
+## Thanks
+
+We value the security of our users and appreciate responsible disclosures. Thank you for helping make `audioarxiv` better and safer!

audioarxiv-0.1.2/SUPPORT.md

@@ -0,0 +1,29 @@
+# Support
+
+Thank you for your interest in **audioarxiv**!
+
+If you have questions, suggestions, or need help using the project, here are some ways to get support:
+
+## 💬 Ask a Question
+
+If you're experiencing a problem or have a question about how to use `audioarxiv`, please open a [GitHub Discussion](https://github.com/isaac-cf-wong/audioarxiv/discussions) or [Issue](https://github.com/isaac-cf-wong/audioarxiv/issues), depending on the nature of your question.
+
+- Use **Discussions** for general questions, ideas, or usage help.
+- Use **Issues** for reporting bugs or requesting new features.
+
+## 🐛 Found a Bug?
+
+Please check if your issue has already been reported. If not, create a [new issue](https://github.com/isaac-cf-wong/audioarxiv/issues/new/choose) with:
+
+- A clear and descriptive title.
+- Steps to reproduce the problem.
+- Relevant logs or error messages.
+- The version of Python and `audioarxiv` you're using.
+
+## 🙋 Want to Contribute?
+
+Contributions are welcome! Please check out the [Contributing Guide](CONTRIBUTING.md) and our [Code of Conduct](CODE_OF_CONDUCT.md) to get started.
+
+---
+
+We appreciate your support and interest in the project!

audioarxiv-0.1.2/codecov.yml

@@ -0,0 +1,12 @@
+coverage:
+  status:
+    project:
+      default:
+        target: auto # auto compares coverage to the previous base commit
+comment: #this is a top-level key
+  layout: " diff, flags, files"
+  behavior: default
+  require_changes: false # if true: only post the comment if coverage changes
+  require_base: false # [true :: must have a base report to post]
+  require_head: true # [true :: must have a head report to post]
+  hide_project_coverage: false # [true :: only show coverage on the git diff aka patch coverage]]

{audioarxiv-0.1.1rc56.post1 → audioarxiv-0.1.2}/cspell.json

@@ -28,6 +28,9 @@
         "recarray",
         "punkt",
         "srepr",
-        "fitz"
+        "fitz",
+        "caplog",
+        "venv",
+        "pytest",
     ]
 }

{audioarxiv-0.1.1rc56.post1 → audioarxiv-0.1.2}/docs/release_notes.rst

@@ -8,10 +8,20 @@ This page summarizes the key updates and changes in each release.
    For the full history and additional context, visit the
    `GitHub Releases <https://github.com/isaac-cf-wong/audioarxiv/releases>`_ page.
 
+Version 0.1.2 (2025-04-20)
+--------------------------
+- Update the LICENSE and the intended audience.
+- Update text in SUPPORT.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, and SECURITY.md.
+- Add more unit tests to increase coverage.
+
+**Full Changelog**: https://github.com/isaac-cf-wong/audioarxiv/compare/v0.1.1...v0.1.2
+
 Version 0.1.1 (2025-04-20)
 --------------------------
 - Update the description of the package in pyproject.toml.
 
+**Full Changelog**: https://github.com/isaac-cf-wong/audioarxiv/compare/v0.1.0...v0.1.1
+
 Version 0.1.0 (2025-04-20)
 --------------------------
 

{audioarxiv-0.1.1rc56.post1 → audioarxiv-0.1.2}/pyproject.toml

@@ -11,7 +11,7 @@ description = "Turn arXiv papers into audio. audioarxiv lets you fetch the resea
 readme = "README.md"
 classifiers = [
     "Development Status :: 3 - Alpha",
-    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3.9",
@@ -55,6 +55,12 @@ test = [
     "pytest-github-actions-annotate-failures",
     "shellcheck-py==0.10.0.1"
 ]
+dev = [
+    "pytest",
+    "pre-commit",
+    "black",
+    "flake8"
+]
 
 [project.urls]
 Documentation = "https://isaac-cf-wong.github.io/audioarxiv"

{audioarxiv-0.1.1rc56.post1 → audioarxiv-0.1.2}/src/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-0.1.1rc56.post1 → audioarxiv-0.1.2}/src/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-0.1.1rc56.post1 → audioarxiv-0.1.2}/src/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-0.1.1rc56.post1 → audioarxiv-0.1.2}/src/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)