fix: add requirements (#123)

Author: alfonsobries

.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ["3.7", "3.8", "3.9"]
 
     steps:
       - uses: actions/checkout@v1
@@ -30,7 +30,7 @@ jobs:
       - name: run tests
         run: |
           . venv/bin/activate
-          mkdir test-results
-          pytest -v -s --junitxml=test-reports/junit.xml --cov=crypto --cov-config=.coveragerc --cov-report xml
+          mkdir -p test-reports
+          pytest -v -s --junitxml=test-reports/junit.xml --cov=client --cov-config=.coveragerc --cov-report xml
       - name: Codecov
         run: bash <(curl -s https://codecov.io/bash) -t ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -24,6 +24,74 @@
 
 If you have any questions, requests or ideas open an issue or ask us in #python on the [ArkEcosystem Slack](https://ark.io/slack).
 
+## Development
+
+### Prerequisites
+
+- Python >= 3.7
+
+### Setup
+
+1. **Create a virtual environment**
+
+Run the following command to create a virtual environment for the project:
+
+```bash
+python -m venv venv
+```
+
+2. Activate the virtual environment
+
+On macOS/Linux:
+
+```bash
+source venv/bin/activate
+```
+
+On Windows
+
+```bash
+.\venv\Scripts\activate
+```
+
+3. Upgrade pip and setuptools
+
+Ensure you have the latest versions of pip and setuptools:
+
+```bash
+pip install --upgrade pip setuptools
+```
+
+4. Install the dependencies
+
+Install all necessary dependencies from the requirements.txt file:
+
+```bash
+pip install -r requirements.txt
+```
+
+5. Install the package in development mode
+
+Run the following command to install the package in development mode:
+
+```bash
+python setup.py develop
+```
+
+6. Run the tests
+
+Use pytest to run the tests and ensure everything is working correctly:
+
+```bash
+python setup.py test
+```
+
+Or directly with pytest:
+
+```bash
+pytest
+```
+
 ## Documentation
 
 You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://docs.ark.io/sdk/clients/usage.html).

requirements.txt

@@ -0,0 +1,30 @@
+atomicwrites==1.4.1
+attrs==23.2.0
+backoff==2.2.1
+certifi==2024.6.2
+chardet==3.0.4
+coverage==7.2.7
+flake8==3.5.0
+flake8-import-order==0.17.1
+flake8-print==3.1.0
+flake8-quotes==1.0.0
+flatten-dict==0.3.0
+idna==2.7
+importlib-metadata==6.7.0
+mccabe==0.6.1
+more-itertools==9.1.0
+pathlib2==2.3.7.post1
+pluggy==0.6.0
+py==1.11.0
+pycodestyle==2.3.1
+pyflakes==1.6.0
+pytest==3.6.1
+pytest-cov==2.5.1
+pytest-mock==1.10.0
+pytest-responses==0.3.0
+requests==2.19.1
+responses==0.10.15
+six==1.16.0
+typing_extensions==4.7.1
+urllib3==1.23
+zipp==3.15.0

setup.py

@@ -2,22 +2,39 @@
 
 import setuptools
 
-
 requires = [
-    'requests>=2.19.1',
-    'backoff>=1.6.0',
-    'flatten_dict>=0.3.0'
+    'atomicwrites==1.4.1',
+    'attrs==23.2.0',
+    'backoff==2.2.1',
+    'certifi==2024.6.2',
+    'chardet==3.0.4',
+    'flatten_dict==0.3.0',
+    'idna==2.7',
+    'importlib-metadata==6.7.0',
+    'mccabe==0.6.1',
+    'more-itertools==9.1.0',
+    'pluggy==0.6.0',
+    'py==1.11.0',
+    'requests==2.19.1',
+    'responses==0.10.15',
+    'six==1.16.0',
+    'typing_extensions==4.7.1',
+    'urllib3==1.23',
+    'zipp==3.15.0'
 ]
 
 tests_require = [
-    'flake8>=3.5.0',
-    'flake8-import-order>=0.17.1',
-    'flake8-print>=3.1.0',
-    'flake8-quotes>=1.0.0',
-    'pytest>=3.6.1',
-    'pytest-responses>=0.3.0',
-    'pytest-mock>=1.10.0',
-    'pytest-cov>=2.5.1'
+    'coverage==7.2.7',
+    'flake8==3.5.0',
+    'flake8-import-order==0.17.1',
+    'flake8-print==3.1.0',
+    'flake8-quotes==1.0.0',
+    'pycodestyle<2.4.0,>=2.0.0',
+    'pyflakes==1.6.0',
+    'pytest==3.6.1',
+    'pytest-cov==2.5.1',
+    'pytest-mock==1.10.0',
+    'pytest-responses==0.3.0'
 ]
 
 extras_require = {