MovetoR&COC
This commit is contained in:
committed by
GitHub
parent
cf0f811750
commit
e0e093b8a6
128
Requirements&COC/CODE_OF_CONDUCT.md
Normal file
128
Requirements&COC/CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,128 @@
|
||||
# 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, 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 e-mail 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
|
||||
[@Harsha200105](https://github.com/Harsha200105).
|
||||
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.0, available at
|
||||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||
enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
80
Requirements&COC/Contributing.md
Normal file
80
Requirements&COC/Contributing.md
Normal file
@@ -0,0 +1,80 @@
|
||||
# 🚀Contribution Guidelines
|
||||
|
||||
Developers are welcome to contribute to this project
|
||||
<br>Initial Step: Comment under the issue you want to work on and get the issue assigned to yourself.
|
||||
<br>
|
||||
# Steps for contributing
|
||||
## Fork this repository
|
||||
Fork the repo by clicking on the Fork option<br>
|
||||
## Clone the repository
|
||||
Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon.
|
||||
|
||||
Open a terminal and run the following git command:
|
||||
|
||||
```
|
||||
git clone "url you just copied"
|
||||
```
|
||||
|
||||
where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.
|
||||
|
||||
For example:
|
||||
|
||||
```
|
||||
git clone https://github.com/YOUR-USERNAME/DesktopAssistant.git
|
||||
```
|
||||
|
||||
where `YOUR-USERNAME` is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.
|
||||
|
||||
## Create a branch
|
||||
|
||||
Change to the repository directory on your computer (if you are not already there):
|
||||
|
||||
```
|
||||
Run `cd DesktopAssitant`
|
||||
```
|
||||
|
||||
Now create a branch using the `git branch` command:
|
||||
|
||||
```
|
||||
Run `git branch <new_branch_name>`
|
||||
```
|
||||
Here, you can try and keep branch name as the number of issue you are trying to solve i.e ```issue_1``` <br>
|
||||
|
||||
Checkout to the new branch so you can push onto the new branch of the forked repository
|
||||
|
||||
```
|
||||
git checkout <new_branch_name>
|
||||
```
|
||||
|
||||
|
||||
## Make necessary changes and commit those changes
|
||||
|
||||
If you go to the project directory and execute the command `git status`, you'll see there are changes.
|
||||
|
||||
Add those changes to the branch you just created using the `git add` command:
|
||||
|
||||
```
|
||||
git add .
|
||||
```
|
||||
|
||||
Now commit those changes using the `git commit` command:
|
||||
|
||||
```
|
||||
git commit -m "anything that expresses whatever changes you have made"
|
||||
```
|
||||
|
||||
## Push changes to GitHub
|
||||
|
||||
Push your changes using the command `git push`:
|
||||
|
||||
```
|
||||
git push origin <new_branch_name>
|
||||
```
|
||||
|
||||
replacing `<new_branch_name>` with the name of the branch you created earlier.
|
||||
|
||||
## Submit your changes for review
|
||||
|
||||
Now you are ready to make a pull request. Go to the forked repo on Github under your profile and a click on the ```Compare & pull request```button. You will be taken to a page where you can create a pull request.
|
||||
When creating a PR, add the linked issue in the description. For example : "Closes #1" if the issue you have resolved is issue #1
|
||||
<br>
|
||||
21
Requirements&COC/LICENSE
Normal file
21
Requirements&COC/LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2021 Technerd brainiac
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
54
Requirements&COC/README.md
Normal file
54
Requirements&COC/README.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# Desktop Assistant
|
||||
|
||||
A Virtual Desktop Assistant Written in Python.
|
||||
<br> It's generally a basic virtual assistant
|
||||
<img src="https://github.com/Harsha200105/DesktopAssitant/blob/main/resource/JJ.jpeg"> <br>
|
||||
The basic purpose of this is to make work easier as it re-directs you to various main sites and performs various important functions for your PC as well just install it for your system and run it in your code editor or IDE. I will be soon updating it as an application for MacOS, Linux and Windows. Until then you can follow the Contributing Guidelines and Contribute into this Desktop Assistant.<br>
|
||||
|
||||
# Installing :
|
||||
|
||||
- Clone the repo to make it available on your local system by using ```git clone <FORKED_REPO_URL>```
|
||||
- cd into the project directory i.e - ```cd DesktopAssitant```
|
||||
|
||||
|
||||
# Requirements for windows
|
||||
Steps to run the Assistant on your pc (use python 3.9)
|
||||
|
||||
Installing all the necessary python module using
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
# Dependency for Ubuntu
|
||||
```
|
||||
sudo apt-get update
|
||||
```
|
||||
```
|
||||
sudo apt-get install espeak
|
||||
```
|
||||
```
|
||||
pip install -r ubuntu_requirements.txt
|
||||
```
|
||||
|
||||
Wow All done! Now give the command to jarvis.
|
||||
|
||||
# Run
|
||||
For windows user run
|
||||
```
|
||||
python Jarvis2_4windows.py
|
||||
```
|
||||
For ubuntu user run
|
||||
```
|
||||
python Jarvis2.py
|
||||
```
|
||||
Wow! all done and now give some voice command
|
||||
# Download
|
||||
- For Windows users, download this [installer](https://raw.githubusercontent.com/Harsha200105/DesktopAssistant/issue_44/bin/jarvis%20desktop%20assistant%20setup.exe)
|
||||
- For Ubuntu users, download this [deb package](https://raw.githubusercontent.com/Harsha200105/DesktopAssistant/issue_44/bin/jarvis_deb.deb).
|
||||
# Contributing Guidelines :<br>
|
||||
- We are Open for Pull Requests
|
||||
- Please contribute and add value to the code
|
||||
- If you have some ideas for new features and you don't have time to implement them please open an issue with the tag new_feature.
|
||||
- Please don't forget to comment (document) your code!
|
||||
- Also If you feel like developing or working out on the Documentation section of this repository make sure to raise an issue regarding and i'll assign you that!
|
||||
- Before creating a Pull Request please go through the above guidelines and the code!
|
||||
|
||||
16
Requirements&COC/config.ini
Normal file
16
Requirements&COC/config.ini
Normal file
@@ -0,0 +1,16 @@
|
||||
[DEFAULT]
|
||||
master = YourName
|
||||
search_engine = Google
|
||||
debug = False
|
||||
musicpath =
|
||||
voice = Male
|
||||
rate = 150
|
||||
volume = 100
|
||||
energy_threshold = 300
|
||||
|
||||
[EMAIL]
|
||||
server = smtp.gmail.com
|
||||
port = 587
|
||||
username =
|
||||
password =
|
||||
|
||||
8
Requirements&COC/requirements.txt
Normal file
8
Requirements&COC/requirements.txt
Normal file
@@ -0,0 +1,8 @@
|
||||
pygame==2.0.1
|
||||
SpeechRecognition==3.8.1
|
||||
wikipedia==1.4.0
|
||||
PyAudio==0.2.11
|
||||
pyttsx3==2.90
|
||||
tk #Tkinter library for using GUI support
|
||||
|
||||
|
||||
80
Requirements&COC/run.md
Normal file
80
Requirements&COC/run.md
Normal file
@@ -0,0 +1,80 @@
|
||||
# How to run the program
|
||||
|
||||
Here are some installation Guidelines and procedure how you can execute the programme and use it for performing basic tasks:
|
||||
|
||||
## Table of Contents:
|
||||
|
||||
- [Check for `PIP` installation](#check-for-pip-installation)
|
||||
- [Pyttsx3](#pyttsx3)
|
||||
- [Speech Recognition](#speech-recognition)
|
||||
- [Pygame <br>](#pygame-)
|
||||
- [Suitable IDE for running this program](#suitable-ide-for-running-this-program)
|
||||
- [Commands to interact with program.](#commands-to-interact-with-program)
|
||||
|
||||
-------------------------------------
|
||||
## Check for `PIP` installation
|
||||
- PIP is a tool that is used to install python packages. PIP is automatically installed with Python 2.7. 9+ and Python 3.4+.
|
||||
- Open the command prompt and enter the below command to check whether pip is installed.
|
||||
```md
|
||||
pip --version
|
||||
```
|
||||
- If you are receiving an error, it means that you might be having `pip3` installed, so try this command.
|
||||
```md
|
||||
pip3 --version
|
||||
```
|
||||
```md
|
||||
python --version
|
||||
```
|
||||
> If you are still facing issues, try installing pip from [here](https://github.com/pypa/pip#readme)
|
||||
|
||||
## Pyttsx3
|
||||
|
||||
<!-- Pyttsx3 -->
|
||||
- pyttsx3 is a text-to-speech conversion library in Python. Unlike alternative libraries, it works offline, and is compatible with both Python 2 and 3
|
||||
- Open the command prompt/terminal and enter the below command to install `pyttsx3`
|
||||
```md
|
||||
pip install pyttsx3
|
||||
```
|
||||
> Visit the [Pyttsx3 documentation](https://pypi.org/project/pyttsx3/) to know more about this library.
|
||||
## Speech Recognition
|
||||
|
||||
- SpeechRecognition is a library for performing speech recognition, with support for several engines and APIs, online and offline.
|
||||
- Open the command prompt/terminal and enter the below command to install `SpeechRecognition`
|
||||
|
||||
```md
|
||||
pip install pyaudio SpeechRecognition
|
||||
```
|
||||
> Visit the [Speech Recognition documentation](https://pypi.org/project/SpeechRecognition/) to know more about this library.
|
||||
|
||||
<!-- pygame -->
|
||||
## Pygame <br>
|
||||
|
||||
- Pygame is a set of Python modules designed for writing video games. Pygame adds functionality on top of the excellent SDL library. This allows you to create fully featured games and multimedia programs in the python language.
|
||||
- Open the command prompt/terminal and enter the below command to install `Pygame`
|
||||
|
||||
```md
|
||||
pip install pygame
|
||||
```
|
||||
|
||||
# Suitable IDE for running this program
|
||||
|
||||
- Desktop Assistant can be run in the following code editor IDEs.
|
||||
- [Pycharm](https://www.jetbrains.com/help/pycharm/installation-guide.html)
|
||||
- [Visual Studio Code](https://code.visualstudio.com/docs)
|
||||
- [Jupyter-lab](https://jupyterlab.readthedocs.io/en/latest/)
|
||||
- [Replit](https://docs.replit.com/)
|
||||
|
||||
# Commands to interact with program.
|
||||
|
||||
After successful installation of the forementioned dependencies, you can use the following commands (speak out) to interact with Jarvis, your `Desktop-Assistant`
|
||||
```
|
||||
Start with : Hello
|
||||
Random Ans : How are you?
|
||||
: Google
|
||||
: Youtube
|
||||
send email : Open email
|
||||
: Nothing
|
||||
: Abort
|
||||
: Stop
|
||||
End with : Bye
|
||||
```
|
||||
47
Requirements&COC/ubuntu_requirements.txt
Normal file
47
Requirements&COC/ubuntu_requirements.txt
Normal file
@@ -0,0 +1,47 @@
|
||||
pip==18
|
||||
pep517
|
||||
pygame==2.0.1
|
||||
pyttsx3==2.90
|
||||
SpeechRecognition==3.8.1
|
||||
wikipedia==1.4.0
|
||||
PyAudio==0.2.11
|
||||
setuptools==58.0.4
|
||||
# sudo apt-get update
|
||||
# sudo apt install portaudio19-dev python3-pyaudio
|
||||
# sudo apt-get install espeak
|
||||
|
||||
## all dependency with version
|
||||
# Name Version Build Channel
|
||||
#_libgcc_mutex 0.1 main
|
||||
#_openmp_mutex 4.5 1_gnu
|
||||
#beautifulsoup4 4.10.0 pypi_0 pypi
|
||||
#ca-certificates 2021.9.30 h06a4308_1
|
||||
#certifi 2021.5.30 py39h06a4308_0
|
||||
#charset-normalizer 2.0.6 pypi_0 pypi
|
||||
#idna 3.2 pypi_0 pypi
|
||||
#ld_impl_linux-64 2.35.1 h7274673_9
|
||||
#libffi 3.3 he6710b0_2
|
||||
#libgcc-ng 9.3.0 h5101ec6_17
|
||||
#libgomp 9.3.0 h5101ec6_17
|
||||
#libstdcxx-ng 9.3.0 hd4cf53a_17
|
||||
#ncurses 6.2 he6710b0_1
|
||||
#openssl 1.1.1l h7f8727e_0
|
||||
#pip 18.0 pypi_0 pypi
|
||||
#pyaudio 0.2.11 pypi_0 pypi
|
||||
#pygame 2.0.1 pypi_0 pypi
|
||||
#python 3.9.7 h12debd9_1
|
||||
#pyttsx3 2.90 pypi_0 pypi
|
||||
#readline 8.1 h27cfd23_0
|
||||
#requests 2.26.0 pypi_0 pypi
|
||||
#setuptools 58.0.4 py39h06a4308_0
|
||||
#soupsieve 2.2.1 pypi_0 pypi
|
||||
#speechrecognition 3.8.1 pypi_0 pypi
|
||||
#sqlite 3.36.0 hc218d9a_0
|
||||
#tk 8.6.11 h1ccaba5_0
|
||||
#tzdata 2021a h5d7bf9c_0
|
||||
#urllib3 1.26.7 pypi_0 pypi
|
||||
#wheel 0.37.0 pyhd3eb1b0_1
|
||||
#wikipedia 1.4.0 pypi_0 pypi
|
||||
#xz 5.2.5 h7b6447c_0
|
||||
#zlib 1.2.11 h7b6447c_3
|
||||
|
||||
Reference in New Issue
Block a user