Modernize Python project setup (#40)

* Add modern Python project setup

* Run pre-commit fixes

Author: MissiaL

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203,W503

.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - uses: pre-commit/action@v3.0.1
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt -r requirements-dev.txt
+      - name: Run tests
+        run: pytest -q

.gitignore

@@ -1,24 +1,106 @@
-.coverage
-MANIFEST
-coverage.xml
-nosetests.xml
-junit-report.xml
-pylint.txt
-toy.py
-tox.ini
-violations.pyflakes.txt
-cover/
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
 build/
-docs/_build
-requests.egg-info/
-*.pyc
-*.swp
+develop-eggs/
+dist/
+downloads/
+.eggs/
+.eggs/**.egg-info/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
 *.egg
-env/
+docs/_build/
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# macOS
+.DS_Store
+
+# VS Code
+.vscode/
+
+# backup files
+*~
+
+# mypy
+.mypy_cache/
+
+# pre-commit
+.pre-commit/
 
-.workon
+# coverage
+htmlcov/
 
-t.py
+# others
 
-t2.py
-dist

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.2.0
+    hooks:
+      - id: flake8

README.md

@@ -1,5 +1,5 @@
 
-[![CircleCI](https://circleci.com/gh/MissiaL/hikvision-client.svg?style=svg)](https://circleci.com/gh/MissiaL/hikvision-client)
+[![CI](https://github.com/MissiaL/hikvision-client/actions/workflows/ci.yml/badge.svg)](https://github.com/MissiaL/hikvision-client/actions/workflows/ci.yml)
 
 
 # Python Library for Hikvision Cameras
@@ -160,12 +160,8 @@ with open('screen.jpg', 'wb') as f:
 
 
 ```bash
-pipenv install --dev
-pipenv run pytest
-pipenv run pytest --cov-report html --cov hikvisionapi # to get coverage report in ./htmlcov/
-
-# or you can get into the virtual env with:
-pipenv shell
-pytest
+python -m pip install -r requirements.txt -r requirements-dev.txt
+pre-commit run --all-files
+pytest --cov-report html --cov hikvisionapi
 ```
 

hikvisionapi/__init__.py

@@ -1,8 +1,9 @@
-from .hikvisionapi import AsyncClient
-from .hikvisionapi import Client
+from .hikvisionapi import AsyncClient, Client
 
-__title__ = 'hikvisionapi'
-__version__ = '0.3.2'
-__author__ = 'Petr Alekseev'
-__license__ = 'MIT'
-__copyright__ = 'Copyright 2018 Petr Alekseev'
+__all__ = ["Client", "AsyncClient"]
+
+__title__ = "hikvisionapi"
+__version__ = "0.3.2"
+__author__ = "Petr Alekseev"
+__license__ = "MIT"
+__copyright__ = "Copyright 2018 Petr Alekseev"