adding docs

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ["https://www.buymeacoffee.com/codeperfectplus"]

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/create-a-new-script.md

@@ -0,0 +1,33 @@
+---
+name: Create a new script
+about: add new script to project
+title: ''
+labels: good first issue, hacktoberfest
+assignees: ''
+
+---
+
+## Script Title -
+
+**what will change** -
+
+## Instructions
+
+- Create a new folder for your script and file/folder name should be appropriate.
+- Create a README.md in your folder for program Instructions
+- add requirements.txt if needed
+
+Please add/delete options that are not relevant.
+
+- [x] Adding New Code
+- [x] Improving Documentation
+
+### Programming Language
+
+- [x] Python
+
+:star2: Star it :fork_and_knife:Fork it :handshake: Contribute to it!
+
+Discord server  - https://discord.gg/FXyh2S3
+
+Happy Coding,

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/report_a_bug.md

@@ -0,0 +1,26 @@
+#### Issue description
+
+
+
+#### Steps to reproduce the issue
+
+1.  
+2. 
+3. 
+
+
+#### What's the expected result?
+
+-
+
+
+#### What's the actual result?
+
+-
+
+
+#### Additional details / screenshot
+
+- ![Screenshot]()
+-
+

.github/ISSUE_TEMPLATE/update-documentation.md

@@ -0,0 +1,11 @@
+---
+name: Update Documentation
+about: Describe this issue template's purpose here.
+title: ''
+labels: documentation, enhancement
+assignees: ''
+
+---
+
+**Short introduction what you want to change in README.md **
+example:- code change, outdated Readme

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+# Pull Request Template
+
+**script name** -
+
+**What have you Changed**
+
+what you changed in the codebase.write here
+
+
+### Issue no.(must) - #
+
+### Self Check(Tick After Making pull Request)
+
+- [ ] This issue was assigned to me.
+- [x] One Change in one Pull Request
+- [x] My file is in proper folder
+- [x] I am following clean code and Documentation and my code is well linted with flake8.
+- [ ] I have added README.md and requirements.txt with my script
+
+If issue was not assigned to you Please don't make a PR. It will marked as invalid.
+
+Join Us on Discord:- https://discord.gg/JfbK3bS

.github/workflows/auto_close_empty_issues.yml

@@ -0,0 +1,20 @@
+# GitHub Action that uses close-issue auto-close empty issues after they are opened.
+# If the issue body text is empty the Action auto-closes it and sends a notification.
+# Otherwise if the issue body is not empty, it does nothing and the issue remains open.
+# https://github.com/marketplace/actions/close-issue
+
+name: auto_close_empty_issues
+on:
+  issues:
+    types: [opened]
+jobs:
+  check-issue-body-not-empty:
+    runs-on: ubuntu-latest
+    steps:
+      - if: github.event.issue.body == 0
+        name: Close Issue
+        uses: peter-evans/close-issue@v1
+        with:
+          comment: |
+            Issue body must contain content.
+            Auto-closing this issue.

.github/workflows/greetings.yml

@@ -0,0 +1,12 @@
+name: "PR Greeter"
+on: [pull_request]
+
+jobs:
+  pr-greeter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Greeter"
+        uses: JJ/pr-greeting-action@releases/v0
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          pr-message: "Hey **#** welcome to this repo"

.github/workflows/python-app.yml

@@ -0,0 +1,17 @@
+on: [pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+            python-version: '3.8'
+      - name: Install flake8
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8
+      - name: Lint with flake8
+        run: flake8 . --isolated --exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox,**/migrations/** --ignore=E203,W503 --max-line-length=119

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Contributing to Audiobook
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## Steps to contribute
+
+* Comment on the issue you want to work on. Make sure it's not assigned to someone else.
+
+### Making a PR
+
+> - Make sure you have been assigned the issue to which you are making a PR.
+> - If you make PR before being assigned, It will be labeled `invalid` and closed without merging.
+
+* Fork the repo and clone it on your machine.
+* Add a upstream link to main branch in your cloned repo
+    ```
+    git remote add upstream https://github.com/codeperfectplus/audiobook.git
+    ```
+* Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)
+    ```
+    git pull upstream master
+    ```
+* Create your feature branch
+    ```
+    git checkout -b <feature-name>
+    ```
+* Commit all the changes
+    ```
+    git commit -am "Meaningful commit message"
+    ```
+* Push the changes for review
+    ```
+    git push origin <branch-name>
+    ```
+* Create a PR from our repo on Github.
+
+### Additional Notes
+
+* Code should be properly commented to ensure it's readability.
+* If you've added code that should be tested, add tests as comments.
+* Make sure your code properly formatted.
+* Issue that pull request!
+* use Flake8 for python code
+
+## Issue suggestions/Bug reporting
+
+When you are creating an issue, make sure it's not already present. Furthermore, provide a proper description of the changes. If you are suggesting any code improvements, provide through details about the improvements.
+
+**Great Issue suggestions** tend to have:
+
+- A quick summary of the changes.
+- In case of any bug provide steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+  - What you expected would happen
+  - What actually happens
+  - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its  [MIT License](http://choosealicense.com/licenses/mit/).
+
+
+## References
+
+This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

Pipfile

@@ -0,0 +1,13 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+pyttsx3 = "*"
+pypdf2 = "*"
+
+[requires]
+python_version = "3.7"