Skip to content
This repository was archived by the owner on Mar 29, 2021. It is now read-only.

Commit 46ba68e

Browse files
committed
Massive docs update. Squash commits
release 0.5.6 remove top image from readme, add pdoc3 to requirement seperate markdown page for pypi updated docs. after some experiments add developer docs auto gen from docstrings update style update links update readme style and crop image update link and redirect update a link towards readme
1 parent d18d6d0 commit 46ba68e

File tree

21 files changed

+2501
-72
lines changed

21 files changed

+2501
-72
lines changed

.github/pypi.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
wappdriver
2+
3+
API for WhatsApp Web Automation
4+
5+
6+
7+
[![Tests](https://img.shields.io/badge/tests-passing-green)](https://aahnik.github.io/wappdriver/docs/Tests.html)
8+
[![Maintenance](https://img.shields.io/maintenance/yes/2020)](https://github.com/aahnik/wappdriver/graphs/commit-activity)
9+
[![GitHub Release](https://img.shields.io/github/v/release/aahnik/wappdriver)](https://github.com/aahnik/wappdriver/releases)
10+
[![CodeFactor](https://www.codefactor.io/repository/github/aahnik/wappdriver/badge)](https://www.codefactor.io/repository/github/aahnik/wappdriver)
11+
[![MIT LICENSE](https://img.shields.io/pypi/l/ansicolortags.svg)](/LICENSE)
12+
13+
---
14+
15+
Wondering how to send WhatsApp messages using Python using only few lines of code? **You have come to the right place!**
16+
17+
_`wappdriver` enables you to send WhatsApp messages programmatically, using only 3 lines of code._
18+
19+
**A python package that helps you automate sending messages through WhatsApp Web 😎**
20+
21+
### _🌟🌟 New_
22+
23+
WappDriver now supports sending **images** , **videos**, **documents** and other file types... _[learn usage](https://aahnik.github.io/wappdriver/docs/Documentation.html)_
24+
25+
### It's very simple to use
26+
27+
![using wappdriver](https://raw.githubusercontent.com/aahnik/wappdriver/main/docs/images/wappdriver.png).
28+
29+
30+
### WARNING ⚠️
31+
32+
- WhatsApp does not allow you to login into the same account from multiple chrome tabs.
33+
So **make sure to close any chrome tab which has WhatsApp Web open**. Not doing so will lead to errors.
34+
- Your phone which is having that WhatsApp account, must stay connected to internet for WhatsApp Web to work
35+
36+
### Requirements
37+
38+
[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
39+
40+
- **[Chrome Browser](https://www.google.com/chrome/)**
41+
- [Chrome Driver](https://chromedriver.chromium.org/)
42+
43+
Make sure to have matching versions of Chrome Browser and Chrome Driver.
44+
I recommend to use the latest stable release of both, for the best performance.
45+
46+
`WappDriver does not support other Browsers. Please use Chrome for a smooth experience`
47+
48+
### Documentation
49+
50+
[Read](https://aahnik.github.io/wappdriver/docs/Documentation.html) the full Documentation to know about all the features.
51+
52+
### Want to contribute ?
53+
54+
Please look at [Code of Conduct](https://github.com/aahnik/wappdriver/blob/master/.github/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct) and [Contributing Guidelines](https://github.com/aahnik/wappdriver/blob/master/.github/CONTRIBUTING.md#how-to-contribute-to-wappdriver-)
55+
56+
Please read the explanation of the detailed working of `wappdriver` from the [Developer's Guide.](https://aahnik.github.io/wappdriver/docs/For_Developers.html)
57+
58+
### Help
59+
60+
Read the [Help Page](/docs/help.md)
61+
62+
For furthur assistance you can ask ![image](https://user-images.githubusercontent.com/66209958/95024578-81ac8300-06a1-11eb-8f56-d4a552135bfd.png) a question in **issues**
63+
64+
---

README.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,31 @@
1-
<div align="center">
2-
3-
![image](https://user-images.githubusercontent.com/66209958/95024996-2760f180-06a4-11eb-8b98-d62c2d1bb26b.png)
1+
# wappdriver
42

5-
</div>
3+
API for WhatsApp Web Automation
64

7-
<h1 align="center">wappdriver</h1>
85

9-
<p align="center">API for WhatsApp Web Automation</p>
6+
Wondering how to send WhatsApp messages using Python using only few lines of code? **You have come to the right place!**
107

11-
<div align="center">
128

139
[![Tests](https://img.shields.io/badge/tests-passing-green)](https://aahnik.github.io/wappdriver/docs/Tests.html)
1410
[![Maintenance](https://img.shields.io/maintenance/yes/2020)](https://github.com/aahnik/wappdriver/graphs/commit-activity)
1511
[![GitHub Release](https://img.shields.io/github/v/release/aahnik/wappdriver)](https://github.com/aahnik/wappdriver/releases)
1612
[![CodeFactor](https://www.codefactor.io/repository/github/aahnik/wappdriver/badge)](https://www.codefactor.io/repository/github/aahnik/wappdriver)
1713

18-
</div>
14+
1915

2016
---
2117

22-
Wondering how to send WhatsApp messages using Python using only few lines of code? **You have come to the right place!**
2318

24-
_`wappdriver` enables you to send WhatsApp messages programmatically, using only 3 lines of code._
19+
🌟🌟 WappDriver now supports sending **images** , **videos**, **documents** and other file types... _[learn usage](https://aahnik.github.io/wappdriver/docs/Documentation.html)_
2520

26-
**A python package that helps you automate sending messages through WhatsApp Web 😎**
21+
### It's very simple to use
2722

28-
### _🌟🌟 New_
23+
![using wappdriver](https://raw.githubusercontent.com/aahnik/wappdriver/main/docs/images/wappdriver.png).
2924

30-
WappDriver now supports sending **images** , **videos**, **documents** and other file types... _[learn usage](https://aahnik.github.io/wappdriver/docs/Documentation.html)_
25+
_`wappdriver` enables you to send WhatsApp messages programmatically, using only 3 lines of code._
3126

32-
### It's very simple to use
27+
**A python package that helps you automate sending messages through WhatsApp Web 😎**
3328

34-
![using wappdriver](https://raw.githubusercontent.com/aahnik/wappdriver/main/docs/images/wappdriver.png).
3529

3630
### How to install ??
3731

docs/Documentation.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,8 @@
11
# Usage Documentation
22

3-
<div align="center">
4-
5-
![image](https://user-images.githubusercontent.com/66209958/95024659-39419500-06a2-11eb-968d-49df41212918.png)
6-
7-
[Readme](/README.md) | [Docs](/docs/Documentation.md) | [Concepts](/docs/concepts.md) | [Developer Guide](/docs/For_Developers.md) | [Help](/docs/help.md)
8-
9-
</div>
10-
11-
This is a detailed documentation for using `wappdriver`. [README](https://aahnik.github.io/wappdriver) for introduction.
3+
[Readme](../README.md) | [Docs](Documentation.md) | [Concepts](concepts.md) | [Developer Guide](For_Developers.md) | [Help](help.md)
124

5+
This is a detailed usage documentation for using `wappdriver`. [README](https://aahnik.github.io/wappdriver) for introduction.
136

147

158
- [Usage Documentation](#usage-documentation)
@@ -116,4 +109,4 @@ The string can be:
116109

117110
---
118111

119-
**If you are a developer and want to contribute code, read [Developer Guide](/docs/For_Developers.md)**
112+
**If you are a developer and want to contribute code, read [Developer Guide](dev/wappdriver/index.html)**

docs/For_Developers.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,10 @@
1-
# Developer's Guide to WappDriver
2-
3-
<div align="center">
4-
5-
![image](https://user-images.githubusercontent.com/66209958/95024787-ffbd5980-06a2-11eb-85ef-4a397d2b01cd.png)
6-
7-
[Readme](/README.md) | [Docs](/docs/Documentation.md) | [Concepts](/docs/concepts.md) | [Developer Guide](/docs/For_Developers.md) | [Help](/docs/help.md)
8-
9-
</div>
10-
11-
If you want to use wappdriver, [read this](/README.md).
12-
13-
If you want to develop or understand how wappdriver works:
14-
15-
- For now you can read the docstrings in the source code from Github.
16-
17-
- A website generated from docstrings will soon be added.
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Aahnik Daw</title>
5+
<meta http-equiv="refresh" content="0; url = https://aahnik.github.io/wappdriver/docs/dev/wappdriver/index.html" />
6+
</head>
7+
<body> </body>
8+
</html>
9+
10+
If you are not redirected click [here](dev/wappdriver/index.html)

docs/concepts.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
# Concepts
22

3-
<div align="center">
43

5-
![image](https://user-images.githubusercontent.com/66209958/95024659-39419500-06a2-11eb-968d-49df41212918.png)
4+
[Readme](../README.md) | [Docs](Documentation.md) | [Concepts](concepts.md) | [Developer Guide](For_Developers.md) | [Help](help.md)
65

7-
[Readme](/README.md) | [Docs](/docs/Documentation.md) | [Concepts](/docs/concepts.md) | [Developer Guide](/docs/For_Developers.md) | [Help](/docs/help.md)
8-
9-
</div>
106

117

128
Here goes a list of concepts I have learned/implemented while building this project.
Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6+
<meta name="generator" content="pdoc 0.9.1" />
7+
<title>wappdriver.command_line API documentation</title>
8+
<meta name="description" content="" />
9+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
10+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
11+
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
12+
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
13+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
14+
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
15+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
16+
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
17+
</head>
18+
<body>
19+
<main>
20+
<article id="content">
21+
<header>
22+
<h1 class="title">Module <code>wappdriver.command_line</code></h1>
23+
</header>
24+
<section id="section-intro">
25+
<details class="source">
26+
<summary>
27+
<span>Expand source code</span>
28+
</summary>
29+
<pre><code class="python">from . import __version__
30+
import argparse
31+
32+
try:
33+
from pyfiglet import Figlet
34+
except Exception:
35+
print(&#39;&#39;&#39;Could not find pyfiglet
36+
Run
37+
pip install pyfiglet
38+
&#39;&#39;&#39;)
39+
40+
41+
def main():
42+
parser = argparse.ArgumentParser()
43+
args = parser.parse_args()
44+
print(f&#39;&#39;&#39;
45+
wappdriver: {__version__}
46+
Command Line App is not availaible.
47+
Please Update wappdriver
48+
&#39;&#39;&#39;)
49+
f = Figlet(font=&#39;big&#39;)
50+
print(f.renderText(&#39;wappdriver&#39;))
51+
52+
53+
if __name__ == &#34;__main__&#34;:
54+
main()</code></pre>
55+
</details>
56+
</section>
57+
<section>
58+
</section>
59+
<section>
60+
</section>
61+
<section>
62+
<h2 class="section-title" id="header-functions">Functions</h2>
63+
<dl>
64+
<dt id="wappdriver.command_line.main"><code class="name flex">
65+
<span>def <span class="ident">main</span></span>(<span>)</span>
66+
</code></dt>
67+
<dd>
68+
<div class="desc"></div>
69+
<details class="source">
70+
<summary>
71+
<span>Expand source code</span>
72+
</summary>
73+
<pre><code class="python">def main():
74+
parser = argparse.ArgumentParser()
75+
args = parser.parse_args()
76+
print(f&#39;&#39;&#39;
77+
wappdriver: {__version__}
78+
Command Line App is not availaible.
79+
Please Update wappdriver
80+
&#39;&#39;&#39;)
81+
f = Figlet(font=&#39;big&#39;)
82+
print(f.renderText(&#39;wappdriver&#39;))</code></pre>
83+
</details>
84+
</dd>
85+
</dl>
86+
</section>
87+
<section>
88+
</section>
89+
</article>
90+
<nav id="sidebar">
91+
<h1>Index</h1>
92+
<div class="toc">
93+
<ul></ul>
94+
</div>
95+
<ul id="index">
96+
<li><h3>Super-module</h3>
97+
<ul>
98+
<li><code><a title="wappdriver" href="index.html">wappdriver</a></code></li>
99+
</ul>
100+
</li>
101+
<li><h3><a href="#header-functions">Functions</a></h3>
102+
<ul class="">
103+
<li><code><a title="wappdriver.command_line.main" href="#wappdriver.command_line.main">main</a></code></li>
104+
</ul>
105+
</li>
106+
</ul>
107+
</nav>
108+
</main>
109+
<footer id="footer">
110+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
111+
</footer>
112+
</body>
113+
</html>

0 commit comments

Comments
 (0)