Skip to content

Commit

Permalink
cleanups
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronhnsy committed Apr 22, 2022
1 parent 3c93f0e commit 38cf85e
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 62 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@

.idea/
dist/
docs/_build
tests/
docs/_build/
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@
author: str = "Axel#3456"
copyright: str = "2022 Axelancerr"

with open(os.path.abspath(os.path.join(os.path.dirname(__file__), '../slate/__init__.py'))) as file:
with open(os.path.abspath(os.path.join(os.path.dirname(__file__), "../slate/__init__.py"))) as file:

if not (match := re.search(r"^__version__: [^=]* = \"([^\"]*)\"", file.read(), re.MULTILINE)):
raise RuntimeError

_VERSION: str = match.group(1)
_VERSION: str = match[1]
version: str = _VERSION
release: str = _VERSION

Expand Down
Binary file removed docs/images/slate.jpg
Binary file not shown.
27 changes: 5 additions & 22 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,17 @@
Welcome to slate
================

.. image:: /images/slate.jpg

slate is a :resource:`lavalink <lavalink>` and :resource:`obsidian <obsidian>`
python wrapper for use with :resource:`discord.py's <discord.py>` command extension.
slate is a discord.py compatible wrapper for lavalink-like applications.

Installation
------------
From PyPI

From GitHub:

.. tab:: Linux

.. code:: bash
git clone https://github.com/Axelware/slate
cd aiolastfm
python3 -m pip install .
.. tab:: Windows

.. code:: bash
git clone https://github.com/Axelware/slate
cd aiolastfm
py -3 -m pip install .
.. code:: bash
git clone https://github.com/Axelware/slate
cd slate
python3.10 -m pip install .
Contents
--------
Expand Down
24 changes: 4 additions & 20 deletions docs/pages/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,45 +4,29 @@ API Reference
=============
placeholder text

Clients
-------
placeholder text

Pool
^^^^
.. autoclass:: Pool
.. autoclass:: slate.Pool
:members:

Node
^^^^
.. autoclass:: Node
.. autoclass:: slate.Node
:members:


Player
^^^^^^
.. autoclass:: Player
.. autoclass:: slate.Player
:members:


Queue
^^^^^
.. autoclass:: Queue
:members:


Utils
----------
placeholder text

.. automodule:: slate.utils
.. autoclass:: slate.Queue
:members:


Exceptions
----------
placeholder text

.. automodule:: slate.exceptions
:members:

Expand Down
43 changes: 26 additions & 17 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
[build-system]
requires = ["poetry_core>=1.0.0"]
build-backend = "poetry.core.masonry.api"


[tool.poetry]
name = "slate"
version = "0.2.2"
Expand All @@ -8,9 +13,7 @@ readme = "README.md"
homepage = "https://github.com/Axelware/slate"
repository = "https://github.com/Axelware/slate"
documentation = "https://slate-py.readthedocs.io/en/latest/"
keywords = [
"obsidian", "lavalink", "api", "wrapper", "async"
]
keywords = ["obsidian", "lavalink", "api", "wrapper", "async"]
classifiers = [
"Framework :: AsyncIO",
"Topic :: Software Development",
Expand All @@ -30,7 +33,7 @@ packages = [
{ include = "slate/py.typed" },
]
include = [
"LICENSE",
"LICENSE"
]


Expand All @@ -43,18 +46,26 @@ sphinxcontrib-trio = { version = "*", optional = true }
sphinx-copybutton = { version = "*", optional = true }
sphinx-inline-tabs = { version = "*", optional = true }
furo = { version = "*", optional = true }
sphinx-autobuild = { version = "*", optional = true }


[tool.poetry.dev-dependencies]
isort = "*"
"discord.py" = { git = "https://github.com/Rapptz/discord.py" }
isort = "*"
typing_extensions = "*"
"discord.py" = { git = "https://github.com/Rapptz/discord.py" }


[tool.poetry.extras]
dev = ["discord.py"]
docs = ["discord.py", "sphinx", "sphinxcontrib-trio", "sphinx-copybutton", "sphinx-inline-tabs", "furo"]
docs-dev = ["discord.py", "sphinx", "sphinxcontrib-trio", "sphinx-copybutton", "sphinx-inline-tabs", "furo", "sphinx-autobuild"]
dev = [
"discord.py"
]
docs = [
"discord.py",
"sphinx",
"sphinxcontrib-trio",
"sphinx-copybutton",
"sphinx-inline-tabs",
"furo"
]


[tool.poetry.urls]
Expand All @@ -78,14 +89,12 @@ import_heading_firstparty = "Local"
import_heading_localfolder = "Local"


[build-system]
requires = ["poetry_core>=1.0.0"]
build-backend = "poetry.core.masonry.api"


[tool.pyright]
include = ["slate"]
verboseOutput = false
include = [
"slate",
"slate/objects",
"slate/types",
]
pythonVersion = "3.10"
typeCheckingMode = "strict"
useLibraryCodeForTypes = true
Expand Down

0 comments on commit 38cf85e

Please sign in to comment.