Use setup.py

foxypool · Mar 1, 2024 · 8661140 · 8661140
1 parent 1951503
commit 8661140
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 22 deletions.
diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
@@ -10,17 +10,11 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
-          architecture: 'x64'
-      - name: Cache dependencies
-        uses: actions/cache@v4
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
+          python-version: '3.11'
+          cache: 'pip'
       - name: Install dependencies
         run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install -r ./requirements.txt
-      - run: mkdocs build
+          python -m pip install --upgrade pip
+          pip install -e .
+      - name: Build site
+        run: mkdocs build
diff --git a/README.md b/README.md
@@ -2,12 +2,7 @@ Foxy-Docs
 ======
 
 [![Software License](https://img.shields.io/badge/license-GPL--3.0-brightgreen.svg?style=flat-square)](LICENSE)
-[![Discord](https://img.shields.io/discord/582180216747720723.svg?label=Discord&style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAAN1wAADdcBQiibeAAABUlJREFUWMO911uMXWUVB/Dft89lOreWMrT0RgutabFWi1JoaxM1EIk2mjQUbeSpKCQqiVFjovbFxBijKMUXo5AgxUu8oWlQgmk0PghW6IPQcHGMrRULDNSZ6UzndDpzZu/lw57pTDO3qtSV7OyTvb5v/f/rv9a39j4JYt9uuBl34+s4giJ99RfeCIvdq6lUM82RrSK+QPo2cSgdfEUaB4fP4Rt4CQ/gQfTAf0skPryWxgD11hWiuFPEXVglpc8r8nt0Xi6bsv7a8ftqfBmPYg/aYt9uU4jOD3zHO8SulYw129VablcUj4r4ElaNL3mzze+hOXKeQB3Lp8TIcAMewgFsRXYxJOLWqzjTV8F2Rf6wiAeJ68djTtgyLz5VV+Sq4w8qaJ8hXis+hHeNl+T+2Le7gfWkdZrnupx4PtMc6SUdk1K3iA5jox8XcQeWzswy2uRjVYxOEAjkcyR2Jb6IXRjBm4h2ZCKICKIh0jGiBRuQZg+XCikFzivQRO886iZsnMPXQWyet0bl6j7V+qgiP1+XHN0XtfmNsW6NgVylKptyxJ7E8P8BfJj0hFpd+unfLujMP41fl9jS07J0WCqhpxI4jf3ov4Top6W0Xz7Wr1afJDClDI/hO5cu+XS/1vZfq9Sknx2fpgDlQLrmEipwtdFz9akPMkwds9uw85LBR7xfnm9X5OJjN86owG1Y9D+izOVcSNzmilXJwGvTCKzATbPtbBTJnxsVI3PEH47M4dFOQ5HNvijiJr2vrJDn0wi8FWtny+mx/qr9r9b9qr+qGdNXjETmB2e77Btc6ZHhxXOpcI2It4miJBCf3ml8nm8RsaD8feGOhPWthYWVcLCv5plGZdqkf2K0ww/PXq4rG7Opem6mzCmCiBZii2ZTfHSzqj0fZM3KzJGjmwyeoX+A04OcGyk3pRLpurbcXUs5ejazvrWYRnJz7axbW0/bUR+ypd6YdBRBtcLCdpZcxpLFXNa5yY4tFSdezlM8ewA6tdQPSWmb5hhDDXpO8Y+TnOojz0lJoFC+u0FzhL8/V96VL5RsXDERtNRZs5z1q1lxBe2tVDPCU5rFLaTBqiwrCUR0oWS7eFF5rVvNyR6e/yu9/VJKk+Az2AW+Ncu5YSOrllKrlIpNlIEuKXVisFpKHO2mfpDEuL61GmtXs7SLZ17g+EuTvllZZLx9Aze+hbaWErCYtqdd0gFVRYF4Tco+JcXVUtqAzVK6FgtF0NHO1uuoVuk+Njt4SmzZyLZNpZKTwINCN46iWzghj56JBp9M/MgDjIwmCzsXqmSbpGyPLN0+LlnZmH94mpd7SrCpPRBR1vp926nXJpTqE34s/EThOSMxoCrSLfsvOGEzWjx7gKFGZvGij8iy76JDSvS8zu8PM9qcJDB6jrYF7Ho3K5dMZN4QPmE4fqSeinTzvTPizDqy0ua9dHYUmmMHRTx5vjeWdLFsyYW9EMFVy7iya1L28Ee5X84FPicBlMextaUh4hHlCSxru3zp+flQRkmsWVb6SivwczUNw8WcEHMSSO/8ZCl1Xjwu4oXxzDQXLfJ61LzazPwzrzmZtRldvMiU6fSiwuNy0gfum5NA1Xw2MsqSrpcNNb4npW9Ksh513+pZYHAonOpbpbXGV7I26yayDw9pSyediXnDZ/MtSNffyeAZ8vz7In4DedCfJ31jmd6ioreoTP6pCIcUHjYc0nvvnS/8/ATAwBmq1V5F8VkRv0WRkITyTpR1/53wGZl/zVf7/4hA2nE3g0NUKt3qlb2DQ+e+ljieUspTSkXixMDQ2D1aKntl/iKvSDvvu5jQ/g1HtBu+eMyiaAAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAxOS0wNC0zMFQxMjozNzoxMC0wNDowMH0cFvgAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMTktMDQtMzBUMTI6Mzc6MTAtMDQ6MDAMQa5EAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAAAABJRU5ErkJggg==)](https://discord.gg/gNHhn9y)
-
-## How to use
-
-- Open https://docs.foxypool.io
-- Profit
+[![Discord](https://img.shields.io/discord/582180216747720723.svg?label=Discord&style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAAN1wAADdcBQiibeAAABUlJREFUWMO911uMXWUVB/Dft89lOreWMrT0RgutabFWi1JoaxM1EIk2mjQUbeSpKCQqiVFjovbFxBijKMUXo5AgxUu8oWlQgmk0PghW6IPQcHGMrRULDNSZ6UzndDpzZu/lw57pTDO3qtSV7OyTvb5v/f/rv9a39j4JYt9uuBl34+s4giJ99RfeCIvdq6lUM82RrSK+QPo2cSgdfEUaB4fP4Rt4CQ/gQfTAf0skPryWxgD11hWiuFPEXVglpc8r8nt0Xi6bsv7a8ftqfBmPYg/aYt9uU4jOD3zHO8SulYw129VablcUj4r4ElaNL3mzze+hOXKeQB3Lp8TIcAMewgFsRXYxJOLWqzjTV8F2Rf6wiAeJ68djTtgyLz5VV+Sq4w8qaJ8hXis+hHeNl+T+2Le7gfWkdZrnupx4PtMc6SUdk1K3iA5jox8XcQeWzswy2uRjVYxOEAjkcyR2Jb6IXRjBm4h2ZCKICKIh0jGiBRuQZg+XCikFzivQRO886iZsnMPXQWyet0bl6j7V+qgiP1+XHN0XtfmNsW6NgVylKptyxJ7E8P8BfJj0hFpd+unfLujMP41fl9jS07J0WCqhpxI4jf3ov4Top6W0Xz7Wr1afJDClDI/hO5cu+XS/1vZfq9Sknx2fpgDlQLrmEipwtdFz9akPMkwds9uw85LBR7xfnm9X5OJjN86owG1Y9D+izOVcSNzmilXJwGvTCKzATbPtbBTJnxsVI3PEH47M4dFOQ5HNvijiJr2vrJDn0wi8FWtny+mx/qr9r9b9qr+qGdNXjETmB2e77Btc6ZHhxXOpcI2It4miJBCf3ml8nm8RsaD8feGOhPWthYWVcLCv5plGZdqkf2K0ww/PXq4rG7Opem6mzCmCiBZii2ZTfHSzqj0fZM3KzJGjmwyeoX+A04OcGyk3pRLpurbcXUs5ejazvrWYRnJz7axbW0/bUR+ypd6YdBRBtcLCdpZcxpLFXNa5yY4tFSdezlM8ewA6tdQPSWmb5hhDDXpO8Y+TnOojz0lJoFC+u0FzhL8/V96VL5RsXDERtNRZs5z1q1lxBe2tVDPCU5rFLaTBqiwrCUR0oWS7eFF5rVvNyR6e/yu9/VJKk+Az2AW+Ncu5YSOrllKrlIpNlIEuKXVisFpKHO2mfpDEuL61GmtXs7SLZ17g+EuTvllZZLx9Aze+hbaWErCYtqdd0gFVRYF4Tco+JcXVUtqAzVK6FgtF0NHO1uuoVuk+Njt4SmzZyLZNpZKTwINCN46iWzghj56JBp9M/MgDjIwmCzsXqmSbpGyPLN0+LlnZmH94mpd7SrCpPRBR1vp926nXJpTqE34s/EThOSMxoCrSLfsvOGEzWjx7gKFGZvGij8iy76JDSvS8zu8PM9qcJDB6jrYF7Ho3K5dMZN4QPmE4fqSeinTzvTPizDqy0ua9dHYUmmMHRTx5vjeWdLFsyYW9EMFVy7iya1L28Ee5X84FPicBlMextaUh4hHlCSxru3zp+flQRkmsWVb6SivwczUNw8WcEHMSSO/8ZCl1Xjwu4oXxzDQXLfJ61LzazPwzrzmZtRldvMiU6fSiwuNy0gfum5NA1Xw2MsqSrpcNNb4npW9Ksh513+pZYHAonOpbpbXGV7I26yayDw9pSyediXnDZ/MtSNffyeAZ8vz7In4DedCfJ31jmd6ioreoTP6pCIcUHjYc0nvvnS/8/ATAwBmq1V5F8VkRv0WRkITyTpR1/53wGZl/zVf7/4hA2nE3g0NUKt3qlb2DQ+e+ljieUspTSkXixMDQ2D1aKntl/iKvSDvvu5jQ/g1HtBu+eMyiaAAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAxOS0wNC0zMFQxMjozNzoxMC0wNDowMH0cFvgAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMTktMDQtMzBUMTI6Mzc6MTAtMDQ6MDAMQa5EAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAAAABJRU5ErkJggg==)](https://discord.gg/foxypool)
 
 ## License
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,2 @@
+[build-system]
+requires = ["setuptools >= 69.0"]
diff --git a/requirements.txt b/requirements.txt
diff --git a/setup.py b/setup.py
@@ -0,0 +1,20 @@
+from setuptools import find_packages, setup
+
+setup(
+    name='foxypool-docs',
+    version='1.0.0',
+    url='https://foxypool.io',
+    license='GPLv3',
+    author='Felix Brucker',
+    author_email='[email protected]',
+    description='Documentation for Foxy related services and tools',
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    python_requires='>=3.11, <4',
+    install_requires=[
+        "mkdocs==1.5.3",
+        "mkdocs-material==9.5.11",
+        "mkdocs-minify-plugin==0.8.0",
+        "mkdocs-redirects==1.2.1",
+    ],
+)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		[build-system]
		requires = ["setuptools >= 69.0"]