Merge pull request #22 from DevCraftClub/build-r-1.0.0

.github/workflows/docs.yml

@@ -0,0 +1,49 @@
+name: website
+
+# build the documentation whenever there are new commits on main
+on:
+  push:
+    branches:
+      - main
+    # Alternative: only build for tags.
+    # tags:
+    #   - '*'
+
+# security: restrict permissions for CI jobs.
+permissions:
+  contents: read
+
+jobs:
+  # Build the documentation and upload the static HTML files as an artifact.
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      # ADJUST THIS: install all dependencies (including pdoc)
+      - run: pip install -e .
+      # ADJUST THIS: build your documentation into docs/.
+      # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
+      - run: python docs/make.py
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/
+
+  # Deploy the artifact to GitHub pages.
+  # This is a separate job so that only actions/deploy-pages has the necessary permissions.
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -106,4 +106,5 @@ dmypy.json
 cython_debug/
 .idea
 .idea/!/NotKinoPoiskAPI/Data/**/
-NotKinoPoiskAPI/Data/**/
+NotKinoPoiskAPI/Data/**/!/notkinopoiskapi.egg-info/
+notkinopoiskapi.egg-info/

build.cmd

@@ -0,0 +1,2 @@
+python -m build
+twine upload dist/*

pyproject.toml

@@ -1,14 +1,24 @@
-[tool.poetry]
+[project]
 name = "notkinopoiskapi"
 version = "1.0.0"
 description = "Неофициальная библиотека для Kinopoisk API Unofficial"
-authors = ["Maxim Harder <dev@devcraft.club>"]
-license = "GPL-3.0-or-later"
+authors = [
+    { "name" = "Maxim Harder", "email" = "dev@devcraft.club"}
+]
+license = { file = "LICENSE" }
 readme = "readme.md"
+classifiers = [
+    "License :: OSI Approved :: GNUv3 License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "requests",
+    "python-decouple"
+]
+keywords = ['api', 'kinopoisk', 'python']
+
+[project.urls]
 homepage = "https://github.com/DevCraftClub/NotKinoPoiskAPI"
 repository = "https://github.com/DevCraftClub/NotKinoPoiskAPI"
-
-[tool.poetry.dependencies]
-python = "^3.8"
-requests = "^2.31.0"
-python-decouple = "^3.8"

readme.md

@@ -1,7 +1,7 @@
 # Неофициальная библиотека для Kinopoisk API Unofficial
 
 Простая библиотека для взаимодействия с Kinopoisk API Unofficial. Полная документация для работы с библиотекой по этому
-адресу:
+адресу: [NotKinoPoiskAPI (GitHub)](https://devcraftclub.github.io/NotKinoPoiskAPI/NotKinoPoiskAPI/)
 
 ## Установка
 

setup.py

@@ -1,25 +1,25 @@
 from setuptools import setup
 
 setup(
-		name="notkionpoiskapi",
-		version="1.0.0",
-		description="Неофициальная библиотека для Kinopoisk API Unofficial",
-		long_description=open("README.md", "r").read(),
-		long_description_content_type="text/markdown",
-		keywords="api kinopoisk python",
-		url="https://github.com/DevCraftClub/NotKinoPoiskAPI",
-		author="Maxim Harder",
-		author_email="dev@devcraft.club",
-		packages=["notkionpoiskapi"],
-		install_requires=[
-				"requests",
-				"python-decouple",
-		],
-		classifiers=[
-				"Programming Language :: Python :: 3.8",
-				"Programming Language :: Python :: 3.9",
-				"Programming Language :: Python :: 3.10",
-				"Programming Language :: Python :: 3.11",
-		],
-		zip_safe=False,
+	name="notkionpoiskapi",
+	version="1.0.0",
+	description="Неофициальная библиотека для Kinopoisk API Unofficial",
+	long_description=open("readme.md", "r", encoding="utf8").read(),
+	long_description_content_type="text/markdown",
+	keywords="api kinopoisk python",
+	url="https://github.com/DevCraftClub/NotKinoPoiskAPI",
+	author="Maxim Harder",
+	author_email="dev@devcraft.club",
+	install_requires=[
+		"requests",
+		"python-decouple",
+	],
+	classifiers=[
+		"License :: OSI Approved :: GNUv3 License",
+		"Programming Language :: Python :: 3.8",
+		"Programming Language :: Python :: 3.9",
+		"Programming Language :: Python :: 3.10",
+		"Programming Language :: Python :: 3.11",
+	],
+	zip_safe=False,
 )