Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add Python 3.12 support #79

Open
wants to merge 33 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
6db23f6
refactor: remove unused import
null8626 Mar 26, 2024
a9f6ee7
meta: update links
null8626 Mar 26, 2024
28c56e4
meta: make the min supported ver 3.8
null8626 Mar 26, 2024
957af68
fix: python 3.12 support
null8626 Mar 26, 2024
3300b50
fix: why does it say 3.1 :skull:
null8626 Mar 26, 2024
c2c7a69
fix: migrate from setup.py to pyproject.toml
null8626 Mar 26, 2024
ee2ec2e
meta: bump version
null8626 Mar 26, 2024
472f69d
ci: support pyproject.toml
null8626 Mar 26, 2024
5ee4fec
feat: add python-publish.yml again with PyPI token support
null8626 Mar 26, 2024
82187cb
meta: update .gitignore [skip ci]
null8626 Mar 26, 2024
f4e83c0
meta: change maintainers
null8626 Mar 27, 2024
533295a
doc: trauma
null8626 Mar 27, 2024
df9b489
meta: remove duplicated path in .gitignore
null8626 Mar 27, 2024
eda566e
meta: update LICENSE
null8626 Mar 27, 2024
e146048
*: use ruff, remove need for default_bot_id, deprecate get_bots, make…
null8626 Mar 28, 2024
a4ce9f2
fix: let's see if this fixes it
null8626 Mar 28, 2024
d4a9123
fix: this should fix it
null8626 Mar 28, 2024
d3b48dc
fix: AAAAAAAAAAHHHHHHH
null8626 Mar 28, 2024
e7bd0b8
fix: fix bot_id test
null8626 Mar 28, 2024
99d8ab7
refactor: collapse if-statement
null8626 Mar 28, 2024
b6be4c4
doc: update readme
null8626 Mar 28, 2024
d2ae045
doc: documentation overhaul
null8626 Mar 28, 2024
99b9bc3
doc: add examples
null8626 Mar 28, 2024
8ea8f7a
doc: more redirects and refactor js script
null8626 Mar 28, 2024
1ed5505
doc: tweaks
null8626 Mar 28, 2024
ad4386b
doc: show monthly downloads
null8626 Mar 28, 2024
dd1a277
doc: show up monthly pypi downloads
null8626 Mar 28, 2024
cd6380f
doc: use pip, not pip3
null8626 Mar 28, 2024
023d63e
meta: update project URLs
null8626 Mar 28, 2024
f80bd29
fix: shutdown web.Application on close()
null8626 Jun 6, 2024
dcfdaea
fix: initialize __app as None at initialization
null8626 Jun 6, 2024
549eb59
meta: bump aiohttp
null8626 Jun 29, 2024
47e96f5
refactor: remove unneeded non-base64 removal
null8626 Jul 1, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* eol=lf
11 changes: 4 additions & 7 deletions .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [ 3.6, 3.7, 3.8, 3.9 ]
null8626 marked this conversation as resolved.
Show resolved Hide resolved
python-version: [ 3.8, 3.9, '3.10', 3.11, 3.12 ]

steps:
- uses: actions/checkout@v2
Expand All @@ -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
6 changes: 3 additions & 3 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.7'
python-version: '3.12'
- 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__'
null8626 marked this conversation as resolved.
Show resolved Hide resolved
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
run: |
python setup.py sdist bdist_wheel
twine upload dist/*
twine upload dist/*
12 changes: 5 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
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
3 changes: 0 additions & 3 deletions .isort.cfg

This file was deleted.

2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ build:
image: latest

python:
version: 3.8
version: 3.12
install:
- requirements: requirements.txt
- requirements: requirements-docs.txt
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
19 changes: 16 additions & 3 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
include LICENSE
include requirements.txt
include README.rst
prune .github
prune .ruff_cache
prune docs
prune examples
prune scripts
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
24 changes: 6 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 0 additions & 7 deletions docs/_static/css/custom.css

This file was deleted.

Binary file added docs/_static/favicon.ico
Binary file not shown.
Binary file removed docs/_static/img/favicon-16x16.png
Binary file not shown.
20 changes: 20 additions & 0 deletions docs/_static/script.js
Original file line number Diff line number Diff line change
@@ -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()
})
}
48 changes: 48 additions & 0 deletions docs/_static/style.css
Original file line number Diff line number Diff line change
@@ -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);
}
19 changes: 0 additions & 19 deletions docs/api.rst

This file was deleted.

6 changes: 3 additions & 3 deletions docs/api/autopost.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#######################
Auto-post API Reference
#######################
##################
Autopost reference
##################

.. automodule:: topgg.autopost
:members:
Expand Down
6 changes: 3 additions & 3 deletions docs/api/client.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
####################
Client API Reference
####################
################
Client reference
################

.. automodule:: topgg.client
:members:
Expand Down
6 changes: 3 additions & 3 deletions docs/api/data.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
##################
Data API Reference
##################
##############
Data reference
##############

.. automodule:: topgg.data
:members:
Expand Down
9 changes: 4 additions & 5 deletions docs/api/errors.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
####################
Errors API Reference
####################
################
Errors reference
################

.. automodule:: topgg.errors
:members:
:inherited-members:
:members:
13 changes: 13 additions & 0 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#############
API reference
#############

.. toctree::
:maxdepth: 2

autopost
client
data
errors
types
webhook
6 changes: 3 additions & 3 deletions docs/api/types.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
####################
Models API Reference
####################
################
Models reference
################

.. automodule:: topgg.types
:members:
Expand Down
6 changes: 3 additions & 3 deletions docs/api/webhook.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#####################
Webhook API Reference
#####################
#################
Webhook reference
#################

.. automodule:: topgg.webhook
:members:
Expand Down
Loading
Loading