Refactor (#7)

* folder structure changes

* Update .gitignore

* Update .gitignore

* exchange and tests

* typo

* tests

* exch

* deflator refactor

* clean tests

* lock and requirements

* tests

* most tests

* improve test coverage

* poetry update

* final tests

* Update test_deflate_function.py

* black

* updates to CI

* Update pyproject.toml

.bumpversion.cfg

@@ -9,8 +9,4 @@ replace = version = "{new_version}"
 
 [bumpversion:file:pydeflate/__init__.py]
 search = __version__ = '{current_version}'
-replace = __version__ = '{new_version}'
-
-[bumpversion:file:docs/source/conf.py]
-search = __version__ = '{current_version}'
-replace = __version__ = '{new_version}'
+replace = __version__ = '{new_version}'

.github/workflows/CI.yaml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.10" ]
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Poetry
+        run: |
+          pip install poetry
+          poetry --version
+      - name: Install packages
+        run: |
+          poetry install
+      - name: Check formatting
+        run: |
+          make check-formatting
+      - name: Tests
+        run: |
+          make report-coverage
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml
+          fail_ci_if_error: true
+          verbose: true

.github/workflows/documentation.yaml

@@ -0,0 +1,27 @@
+# Build documentation
+name: documentation
+
+on:
+  workflow_dispatch:
+
+jobs:
+  documentation:
+    runs-on: ubuntu-latest
+    name: Build documentation
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+
+      - name: Install poetry
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+      - name: Install package
+        run: poetry install
+
+      - name: Build documentation
+        run: poetry run make html --directory docs/

.github/workflows/release.yml → .github/workflows/release.yaml

@@ -1,10 +1,10 @@
-name: release & publish
+name: release
 
 on:
-   push:
+  push:
     tags:
       - 'v*'
-   workflow_dispatch:
+  workflow_dispatch:
 
 jobs:
 
@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        python-versions: ["3.9"]
+        python-versions: [ "3.10" ]
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
@@ -23,6 +23,8 @@ jobs:
         run: |
           echo ::set-output name=current_version::${GITHUB_REF#refs/tags/v}
         shell: bash
+      - name: Get version from tag (new)
+        run: echo "{current_version}={${GITHUB_REF#refs/tags/v}}" >> $GITHUB_OUTPUT
 
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v2
@@ -34,8 +36,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install poetry
-          pip install -r requirements.txt
-
+          poetry install
       - name: Build wheels and source tarball
         run: >-
           poetry build

.gitignore

@@ -117,8 +117,11 @@ dmypy.json
 # MAC
 .DS_Store
 pydeflate/.DS_Store
-pydeflate/.DS_Store
 *.icloud
 
 # DataSpell
 .idea/
+
+# Packaged data
+/pydeflate/.pydeflate_data/
+/.reports/

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: docs/requirements.txt