Top-gg-Community · null8626 · Mar 26, 2024 · Mar 26, 2024 · Mar 26, 2024 · Mar 26, 2024
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* eol=lf
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ 3.6, 3.7, 3.8, 3.9 ]
+        python-version: [ 3.8, 3.9, '3.10', 3.11, 3.12, 3.13 ]
 
     steps:
       - uses: actions/checkout@v2
@@ -29,13 +29,10 @@ jobs:
           path: "requirements-dev.txt"
       - name: Install itself
         run: |
-          python setup.py install
-      - name: Lint with flake8
+          python -m pip install .
+      - name: Lint with ruff
         run: |
-          # stop the build if there are Python syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=120 --statistics
+          ruff check
       - name: Test with pytest
         run: |
           pytest
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -17,15 +17,15 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: '3.7'
+          python-version: '3.13'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install setuptools wheel twine -r requirements.txt
       - name: Build and publish
         env:
-          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_USERNAME: '__token__'
           TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
         run: |
           python setup.py sdist bdist_wheel
-          twine upload dist/*
+          twine upload dist/*
diff --git a/.gitignore b/.gitignore
@@ -1,11 +1,10 @@
-dblpy.egg-info/
 topggpy.egg-info/
-topgg/__pycache__/
 build/
 dist/
-/docs/_build
-/docs/_templates
-.vscode
-/.idea/
-__pycache__
+docs/_build
+docs/_templates
+.vscode/
+.idea/
+**/__pycache__/
 .coverage
+.ruff_cache/
diff --git a/.isort.cfg b/.isort.cfg
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -7,7 +7,7 @@ build:
    image: latest
 
 python:
-  version: 3.8
+  version: 3.13
   install:
     - requirements: requirements.txt
     - requirements: requirements-docs.txt
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,5 @@
 Copyright 2021 Assanali Mukhanov & Top.gg
+Copyright 2024 null8626 & Top.gg
 
 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:
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,15 @@
-include LICENSE
-include requirements.txt
-include README.rst
+prune .github
+prune .ruff_cache
+prune docs
+prune examples
+prune tests
+exclude .gitattributes
+exclude .gitignore
+exclude .readthedocs.yml
+exclude mypy.ini
+exclude pytest.ini
+exclude requirements-dev.txt
+exclude requirements-docs.txt
+exclude ruff.toml
+exclude ISSUE_TEMPLATE.md
+exclude PULL_REQUEST_TEMPLATE.md
diff --git a/README.rst b/README.rst
@@ -4,42 +4,30 @@ Top.gg Python Library
 
 .. image:: https://img.shields.io/pypi/v/topggpy.svg
    :target: https://pypi.python.org/pypi/topggpy
-   :alt: View on PyPi
-.. image:: https://img.shields.io/pypi/pyversions/topggpy.svg
-   :target: https://pypi.python.org/pypi/topggpy
-   :alt: v1.0.0
-.. image:: https://readthedocs.org/projects/topggpy/badge/?version=latest
+   :alt: View on PyPI
+.. image:: https://img.shields.io/pypi/dm/topggpy?style=flat-square
    :target: https://topggpy.readthedocs.io/en/latest/?badge=latest
-   :alt: Documentation Status
+   :alt: Monthly PyPI downloads
 
-A simple API wrapper for `Top.gg <https://top.gg/>`_ written in Python, supporting discord.py.
+A simple API wrapper for `Top.gg <https://top.gg/>`_ written in Python.
 
 Installation
 ------------
 
-Install via pip (recommended)
-
-.. code:: bash
-
-    pip3 install topggpy
-
-Install from source
-
 .. code:: bash
 
-    pip3 install git+https://github.com/top-gg/python-sdk/
+    pip install topggpy
 
 Documentation
 -------------
 
-Documentation can be found `here <https://topggpy.rtfd.io>`_
+Documentation can be found `here <https://topggpy.readthedocs.io/en/latest/>`_
 
 Features
 --------
 
 * POST server count
 * GET bot info, server count, upvote info
-* GET all bots
 * GET user info
 * GET widgets (large and small) including custom ones. See `docs.top.gg <https://docs.top.gg/>`_ for more info.
 * GET weekend status

diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
diff --git a/docs/_static/img/favicon-16x16.png b/docs/_static/img/favicon-16x16.png
diff --git a/docs/_static/script.js b/docs/_static/script.js
@@ -0,0 +1,20 @@
+document.addEventListener('load', () => {
+  try {
+    document.querySelector('.edit-this-page').remove()
+
+    // remove these useless crap that appears on official readthedocs builds
+    document.querySelector('#furo-readthedocs-versions').remove()
+    document.querySelector('.injected').remove()
+  } catch {
+    // we're building this locally, forget it
+  }
+})
+
+for (const label of document.querySelectorAll('.sidebar-container label')) {
+  const link = [...label.parentElement.children].find(child => child.nodeName === 'A')
+
+  link.addEventListener('click', event => {
+    event.preventDefault()
+    label.click()
+  })
+}
diff --git a/docs/_static/style.css b/docs/_static/style.css
@@ -0,0 +1,48 @@
+body {
+  --color-link-underline: rgba(0, 0, 0, 0);
+  --color-link-underline--hover: var(--color-link);
+  --color-inline-code-background: rgba(0, 0, 0, 0);
+  --color-api-background-hover: var(--color-background-primary);
+  --color-highlight-on-target: var(--color-background-primary) !important;
+
+  --font-stack: "Inter", sans-serif !important;
+  --font-stack--monospace: "Roboto Mono", monospace !important;
+}
+
+aside.toc-drawer {
+  visibility: hidden;
+}
+
+#furo-readthedocs-versions, .injected, .edit-this-page, .related-pages, .headerlink {
+  visibility: hidden;
+  user-select: none;
+}
+
+dd dt {
+  color: var(--color-foreground-secondary);
+}
+
+aside.toc-drawer .docutils:hover, .sidebar-brand-text:hover {
+  transition: 0.15s;
+  filter: opacity(75%);
+}
+
+.highlight .c1, em {
+  font-style: normal !important;
+}
+
+.highlight .nn {
+  text-decoration: none !important;
+}
+
+h1 {
+  font-weight: 900;
+}
+
+.sidebar-brand-text {
+  font-weight: bolder;
+}
+
+.sidebar-scroll .reference.internal {
+  color: var(--color-brand-primary);
+}
diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/api/autopost.rst b/docs/api/autopost.rst
@@ -1,6 +1,6 @@
-#######################
-Auto-post API Reference
-#######################
+##################
+Autopost reference
+##################
 
 .. automodule:: topgg.autopost
     :members:

diff --git a/docs/api/client.rst b/docs/api/client.rst
@@ -1,6 +1,6 @@
-####################
-Client API Reference
-####################
+################
+Client reference
+################
 
 .. automodule:: topgg.client
     :members:

diff --git a/docs/api/data.rst b/docs/api/data.rst
@@ -1,6 +1,6 @@
-##################
-Data API Reference
-##################
+##############
+Data reference
+##############
 
 .. automodule:: topgg.data
     :members:

diff --git a/docs/api/errors.rst b/docs/api/errors.rst
@@ -1,7 +1,6 @@
-####################
-Errors API Reference
-####################
+################
+Errors reference
+################
 
 .. automodule:: topgg.errors
-    :members:
-    :inherited-members:
+    :members:
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,13 @@
+#############
+API reference
+#############
+
+ .. toctree::
+    :maxdepth: 2
+
+    autopost
+    client
+    data
+    errors
+    types
+    webhook
diff --git a/docs/api/types.rst b/docs/api/types.rst
@@ -1,6 +1,6 @@
-####################
-Models API Reference
-####################
+################
+Models reference
+################
 
 .. automodule:: topgg.types
     :members:

diff --git a/docs/api/webhook.rst b/docs/api/webhook.rst
@@ -1,6 +1,6 @@
-#####################
-Webhook API Reference
-#####################
+#################
+Webhook reference
+#################
 
 .. automodule:: topgg.webhook
     :members: