Refactor build and environment setup (#6)

- Updated `build_dev.sh` to use `python -m build` instead of `setup.py`.
- Modified `environment.yml` to specify Python 3.10 and updated dependencies.
- Added `requirements-dev.txt` for development dependencies.
- Enhanced `README.md` with clearer instructions for building from source.
- Updated CI workflows to use newer action versions and Python 3.10.
- Refined version handling in `versioneer.py` and `_version.py` for better compatibility.

Author: caponetto

.github/workflows/ci.yml

@@ -11,13 +11,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.8.3
+          python-version: '3.10'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -35,12 +33,12 @@ jobs:
         run: |
           python setup.py sdist bdist_wheel
       - name: Upload artifacts
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: bhc
           path: dist/
       - name: Upload coverage report
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: coverage
           path: coverage_report/

.github/workflows/less-is-more.yml

@@ -2,21 +2,19 @@ name: Artifact size validation
 
 on:
   pull_request:
-    branches: "**"
+    branches: ["**"]
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
+      - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.8.3
+          python-version: '3.10'
 
       - name: Install dependencies
         run: |

README.md

@@ -9,23 +9,51 @@ It also includes the Bayesian Rose Trees extension proposed by Blundell et al (2
 > BLUNDELL, Charles; TEH, Yee Whye; HELLER, Katherine A. Bayesian rose trees. arXiv preprint arXiv:1203.3468, 2012.
 
 ## How to build from source
+
+### Using Conda (Recommended)
+
 1. Create an anaconda environment using the [environment.yml](environment.yml) file.
 
-    `$ conda env create -f environment.yml`
+    ```bash
+    $ conda env create -f environment.yml
+    ```
 
 2. Activate the environment after the installation is completed.
 
-    `$ conda activate bayesian-hierarchical-clustering`
+    ```bash
+    $ conda activate bayesian-hierarchical-clustering
+    ```
+
+3. Run the build script.
+
+    ```bash
+    $ ./build_dev.sh
+    ```
+
+### Using pip
+
+Alternatively, if you prefer using pip:
+
+1. Create a virtual environment.
+
+    ```bash
+    $ python -m venv venv
+    $ source venv/bin/activate  # On Windows: venv\Scripts\activate
+    ```
 
-3. Install the following libraries: `pytest`, `coverage` and `flake8`.
+2. Install development dependencies.
 
-    `$ conda install pytest coverage flake8`
+    ```bash
+    $ pip install -r requirements-dev.txt
+    ```
 
-4. Run the `build_dev.sh` script.
+3. Run the build script.
 
-    `$ ./build_dev.sh`
+    ```bash
+    $ ./build_dev.sh
+    ```
 
-The files will be available in the `dist` folder.
+The built packages will be available in the `dist` folder.
 
 ## Examples
 

bhc/__init__.py

@@ -10,3 +10,6 @@
 
 __version__ = get_versions()['version']
 del get_versions
+
+from . import _version
+__version__ = _version.get_versions()['version']