diff --git a/.github/workflows/python-tests.yml b/.github/workflows/python-tests.yml new file mode 100644 index 0000000..d637b9e --- /dev/null +++ b/.github/workflows/python-tests.yml @@ -0,0 +1,35 @@ +name: Python Tests + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build-and-test: + strategy: + matrix: + os: [ubuntu-latest] + python-version: ["3.10"] + + runs-on: ${{ matrix.os }} + + steps: + - uses: actions/checkout@v3 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install .[dev] # if you defined a dev optional dep in pyproject.toml + # or use: pip install . pytest + + - name: Run tests + run: | + pytest --version + pytest tests diff --git a/README.md b/README.md index 98b1a60..b3cefdd 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Use it out of the box, or extend it with your own aggregation logic! To install the aggrigator, clone the repository, navigate inside the directory and run the following command: ```bash -pip install -e . +pip install aggrigator ``` now you can import the library in your python code with: @@ -26,20 +26,6 @@ now you can import the library in your python code with: import aggrigator ``` -## Testing - -To run the tests locally, navigate inside the aggrigator directory and first install the dev dependencies if needed: - -```bash -pip install .[dev] -``` - -and then run the tests with: - -```bash -pytest tests -``` - ## Try it out yourself Check out the interactive [example_notebook.ipynb](example_notebook.ipynb) to see **Aggrigator** in action. diff --git a/pyproject.toml b/pyproject.toml index 5f7b056..8334f00 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,16 +4,16 @@ build-backend = "setuptools.build_meta" [project] name = "aggrigator" # your package name -version = "0.1.0" # initial version +version = "0.1.0b1" # initial version description = "A Python package for aggregation tasks" authors = [ { name="Christoph Karg", email="christoph.karg@mdc-berlin.de" } ] license = { file = "LICENSE" } readme = "README.md" -requires-python = ">=3.7" +requires-python = ">=3.10" dependencies = [ - "numpy", + "numpy>=2.0", # TODO fix major version "pandas", "scipy", "matplotlib", @@ -24,14 +24,13 @@ dependencies = [ "scikit-learn", "scikit-image", "libpysal", - "esda", "openpyxl", "numba", ] [project.urls] -"Homepage" = "https://github.com/Kainmueller-Lab/AggroUQ" -"Repository" = "https://github.com/Kainmueller-Lab/AggroUQ" +"Homepage" = "https://github.com/Kainmueller-Lab/aggrigator" +"Repository" = "https://github.com/Kainmueller-Lab/aggrigator" [project.optional-dependencies] dev = [