Git Product home page Git Product logo

py-contributors / audiobook Goto Github PK

View Code? Open in Web Editor NEW
48.0 6.0 25.0 245 KB

Listen to Pdf/Rtf/txt/docs/epub/mobi/odt book with just a few line of Python code. Leave a :star: if you like It.

Home Page: https://audiobook.readthedocs.io/

License: MIT License

Python 34.05% Shell 2.76% Rich Text Format 63.19%
audiobook pypi pypi-package pypi-packages hacktoberfest pdf python3 python pip-package

audiobook's Introduction

website title image

πŸ‘‰ CLI tool to listen to your favourite book in Python πŸ‘ˆ

Twitter


repo language github stars github forks code size

pypi status download docs dependices

discord invite total contributors

Installation

Install using pypi

Using pip

pip install audiobook

Documentation

Check the full documentation here:- Read the docs

Contributing

Check the Contributing for the contribution guidelines.

Supported File Formats

File Format Supported
PDF βœ…
TXT βœ…
EPUB βœ…
MOBI βœ…
HTML βœ…
DOCX βœ…
ODT βœ…
RTF βœ…

Changelog and Release Notes

Check the changelog and release notes here

Contributors

audiobook's People

Contributors

aaaandrzej avatar aayushi-droid avatar chmey avatar codeperfectplus avatar dependabot[bot] avatar drakeentity avatar ezinneanne avatar flower-of-the-bridges avatar hot9cups avatar joeamedeo avatar mr-vabs avatar sarojwasti avatar suvoo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

audiobook's Issues

Voice: text to speech

Is your feature request related to a problem? Please describe.

Currently, There is one default voice for reading the book. There should also be an option for the user to select the other voice respective to their os platform.

Feature: `docs/docx` file support adding

Is your feature request related to a problem? Please describe.
Adding Doc/Docx file support for audiobooks.

Describe the solution you'd like
I will use the docs2txt library to read docs files in python.

Describe alternatives you've considered
Have to find any other library if there is one.

Additional context
Add any other context or screenshots about the feature request here.

Improve Overall Documentation

Want to improve documentation to make it look like more professional. As of now there are some grammar and casing mistakes.

There is an error in the CONTRIBUTING.md file

**Short introduction what you want to change in README.md **
In the Contributing.md file, there is git pull upstream master.
This is wrong as the name of the main branch is dev and not master.
Also, there should be git add before git commit. This is because, as this project is open to everyone including beginners, it would be helpful to add all the necessary details.

Add CLI

Is your feature request related to a problem? Please describe.
It's not clear now how one should run the script, CLI method and relevant "Usage" part in README would be useful

Describe the solution you'd like
click could be used - up to an author and maintainers

Describe alternatives you've considered
sys.argv is an alternative

Additional context
N/A

adding more extraction engine

Feature proposal (Draft)

Adding more extraction engines. Some of the engines may be fast, some may be accurate. so there should be a user choice to select the engine.

Currently, PDF has two Extraction Engines(modules).

  • PDFMiner-
  • PdfParser-

For Doc/Docx -

  • doc2text (Implemented)
  • docs - not yet

read password protected file

Currently, password-protected files will not work. Need to implement a solution to read the password-protected file.

Bug: Fix documentation at Read the Docs site

Describe the bug
Documentation at linked Read the Docs site does not show actual readme

To Reproduce
Go to https://github.com/Py-Contributors/AudioBook#documentation and click the link, it redirects to an empty page at https://audiobook.readthedocs.io/

Expected behavior
This site is normally autogenerated, it says: "Please create an index.rst or README.rst file with your own content under the root (or /docs) directory in your repository.". Ideally such file should be created (or the link removed to avoid confusion).

Screenshots
N/A

Desktop (please complete the following information):
N/A

Smartphone (please complete the following information):
N/A

Additional context
N/A

Feature: Add play/stop audio while playing

Is your feature request related to a problem? Please describe.
The program should be able to start/stop the speak_text method from pyttsx3

Describe the solution you'd like
The audio from a text should be able to be stopped/resumed from within the command line

[DOCS] Broken Badges

Broken Badges
I'd suggest either removing the broken badges from the docs .md file or replacing the badges with static ones. The reason that this bug is happening is that Shields.io uses a Pipfile.lock to determine the version and dependencies - and this repo lacks the same.

image

Update tests

Describe the bug
Unit tests no longer make sense, probably after recent refactoring

To Reproduce
Try to run the tests or have a look at the methods being "tested" - they don't make sense now.

Expected behavior
Tests should be rewritten to test actual methods of AudioBook()

Screenshots
N/A

Desktop (please complete the following information):
N/A

Smartphone (please complete the following information):
N/A

Additional context
N/A

Bug: PyPf2 missed words some times

Describe the bug
PyPdf2 sometimes misses the words. PDFMinor is Better than text extracting than PyPDF2. So will be adding support for Pdfminor.
User can choose which engine he/she wants to select. the default will be Pdfminor.

PDFMiner – This library is used to extract useful information from PDF documents. Unlike other tools, the entire focus of this package is to get and analyze the data.

PyPDF2 – This is a PDF library made of pure Python that can harvest, split, transform, and merge PDFs together.

Expected behavior
A clear and concise description of what you expected to happen.

Desktop (please complete the following information):
N/A

Smartphone (please complete the following information):
N/A

Additional context
N/A

Text highlighting

Is your feature request related to a problem? Please describe.
I'm always frustrated when I am looking for a particular text and I have go line by line to find what I am looking for.

Describe the solution you'd like
I want to contribute a highlighting a new feature to the PDF reader, where I can easily highlight a text and it highlight all text in the PDF.

Describe alternatives you've considered
Pretty much reading the whole PDF, which is not time managing.

@codeperfectplus , Please assign this issue to me, so I can work on it and contribute.

extending the current documentation for readthedocs

Is your feature request related to a problem? Please describe.

Current Documentation is not sufficient. we have to extend it.

Plan for Docs

will use SphinxΒΆ for documentation and write proper multipage documentation.

why multipage documentaion

The current one-page documentation is messy. so we can divide it into easy components and extend the documentation. so it can be clearly explained in detail.

Proposed Pages of site

  1. Introduction
  2. Installation
  3. Use as a module
  4. Use as a command line tool (save/read audiobook)
  5. Upcoming changes
  6. common problems while installing on Linux

This issue is open to assigning.

Branch:- https://github.com/Py-Contributors/AudioBook/tree/docs

Reference:-

https://pypdf2.readthedocs.io/en/latest/
https://flask.palletsprojects.com/en/2.2.x/

support: ODT file support adding

Is your feature request related to a problem? Please describe.

Audiobook doesn't support ODT file format yet. So creating a feature request for ODT file request. A file with the β€œ.odt” extension is an OpenOffice Document file. It's a common file type in Linux.

@DrakeEntity

support: adding RTF file support

Is your feature request related to a problem? Please describe.
Audiobook doesn't support the RTF file format yet. So creating a feature request for RTF file request. A file with the β€œ.rtf” extension is an OpenOffice Document file. It's a common file type in Linux and used as a substitute to .doc, very helpful in converting to PDF as well.
@codeperfectplus

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.