Merge branch 'v3-alpha' into main

.gitignore

@@ -1,10 +1,6 @@
-dist/
-.vscode/
-.idea/
-*/**/__pycache__/*
-venv/
-*.egg-info/
+__pycache__
+*.egg-info
+build
+dist
 
-# Testing scripts
-sample.py
-test.py
+venv

.todo

@@ -0,0 +1,14 @@
+✔ Basic messaging support @done(21-05-01 18:19)
+☐ Room actions
+☐ Voice Support
+
+☐ Housekeeping
+  ✘ Logic Separation @cancelled(21-05-02 17:07)
+    # Turns out there's no sane way in Python to split classes.
+    # Just making as many delegating functions as possible is the best I can do.
+  ☐ Documentation on Read the docs
+
+☐ Testing
+  ☐ API testing with pytest
+  ☐ Doctests
+  ☐ Tox

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "python.pythonPath": "./venv/bin/python",
+  "python.linting.mypyPath": "./venv/bin/mypy"
+}

.whitesource

@@ -9,4 +9,4 @@
   "issueSettings": {
     "minSeverityLevel": "LOW"
   }
-}
+}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Arthur
+Copyright (c) 2021 Tushar Sadhwani
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

README.md

@@ -0,0 +1,51 @@
+# dogehouse.py
+
+Python wrapper for the dogehouse API.
+
+[![pypi](https://img.shields.io/badge/pypi-dogehouse-blue)](https://pypi.org/project/dogehouse)
+
+## Documentation
+
+You can find the documentation at [The DogeGarden Wiki](https://wiki.dogegarden.net)
+
+## Installation
+
+`pip install dogehouse`
+
+## Example
+
+```python
+from dogehouse import DogeClient
+from dogehouse.entities import ReadyEvent, UserJoinEvent, MessageEvent
+
+doge = DogeClient("token", "refresh_token")
+
+
+@doge.on_ready
+async def make_my_room(event: ReadyEvent) -> None:
+    print(f"Successfully connected as @{event.user.username}!")
+    await doge.create_room("Hello World!")
+
+
+@doge.on_user_join
+async def greet_user(event: UserJoinEvent) -> None:
+    await doge.send_message(f"Hello @{event.user.username}")
+
+
+@doge.command
+async def echo(event: MessageEvent) -> None:
+    msg = event.message
+    await doge.send_message(f'@{msg.author.username} said {msg.content}')
+
+
+doge.run()
+```
+
+Check [examples](./examples/basic_bot.py) for more feature usage.
+
+## Tokens
+
+- Go to [dogehouse.tv](https://dogehouse.tv)
+- Open Developer options (<kbd>F12</kbd> or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd>)
+- Go to Application > Local Storage > dogehouse&period;tv
+- There lies your `TOKEN` and `REFRESH_TOKEN`

docs/README.md

@@ -1,32 +1,32 @@
 # Welcome to dogehouse.py
 
-dogehouse.py is an easy to use, fully async, [discord.py](https://discordpy.readthedocs.io/) like python wrapper
+dogehouse.py is an easy to use, fully async,
+[discord.py](https://discordpy.readthedocs.io/)-like python wrapper
 for [dogehouse.tv](https://dogehouse.tv).
 
-### Features:
+## Features
 
-* Modern pythonic syntax using `async`/`await` syntax
-* Command handling & parsing like `discord.py`
-* Easy to use with an object-oriented design
+- Modern pythonic syntax using `async`/`await` syntax
+- Command handling & parsing like `discord.py`
+- Easy to use with an object-oriented design
 
-#### Planned features:
+### Planned features
 
-* [dogehouse.xyz](https://stats.dogehouse.xyz) telemetry implementation
-* Efficient caching system
+- [dogehouse.xyz](https://stats.dogehouse.xyz) telemetry implementation
+- Efficient caching system
 
 ## Getting started
 
 If it is your first time using the library, these are the spots to get started!
 
-* First steps: [Introduction](intro), [Quickstart](quickstart)
-* Working with Dogehouse: [Getting your tokens](quickstart?id=client-credentials)
-* Examples: Examples are available in the [repository](https://github.com/Arthurdw/dogehouse.py/tree/main/examples)
+- First steps: [Introduction](intro), [Quickstart](quickstart)
+- Working with Dogehouse: [Getting your tokens](quickstart?id=client-credentials)
+- Examples: Examples are available in the [repository](https://github.com/dogegarden/dogehouse.py/tree/main/examples)
 
 ## Support
 
 If you are having trouble with something, these resources might help.
 
-* Ask us in the [Dogegarden discord](https://discord.gg/S5yJECfc8d) or in
+- Ask us in the [Dogegarden discord](https://discord.gg/S5yJECfc8d) or in
   the [Xiler discord server](https://dc.xiler.net)
-* Report bugs in the [issue tracker](https://github.com/Arthurdw/dogehouse.py/issues)
-
+- Report bugs in the [issue tracker](https://github.com/dogegarden/dogehouse.py/issues)